add some source documentation

to domain controller and preferences form

lib/NGCP/Panel/Controller/Domain.pm

@@ -9,18 +9,6 @@ BEGIN { extends 'Catalyst::Controller'; }
 use NGCP::Panel::Form::Domain;
 use NGCP::Panel::Form::Preferences;
 
-=head1 NAME
-
-NGCP::Panel::Controller::Domain - Catalyst Controller
-
-=head1 DESCRIPTION
-
-Catalyst Controller.
-
-=head1 METHODS
-
-=cut
-
 sub list :Chained('/') :PathPart('domain') :CaptureArgs(0) :Args(0) {
     my ($self, $c) = @_;
 
@@ -326,6 +314,78 @@ sub load_preference_list : Private {
     $c->stash(pref_groups => \@dom_pref_groups);
 }
 
+__PACKAGE__->meta->make_immutable;
+
+1;
+
+__END__
+
+=head1 NAME
+
+NGCP::Panel::Controller::Domain - Catalyst Controller
+
+=head1 DESCRIPTION
+
+Catalyst Controller.
+
+=head1 METHODS
+
+=head2 list
+
+basis for the domain controller
+
+=head2 root
+
+=head2 create
+
+Provide a form to create new domains. Handle posted data and create domains.
+
+=head2 search
+
+obsolete
+
+=head2 base
+
+Fetch a domain by its id.
+
+Data that is put on stash: domain, domain_result
+
+=head2 edit
+
+probably obsolete
+
+=head2 delete
+
+deletes a domain (defined in base)
+
+=head2 ajax
+
+Get domains and output them as JSON.
+
+=head2 preferences
+
+Show a table view of preferences.
+
+Data that is put on stash: provisioning_domain_id
+
+=head2 preferences_detail
+
+Get details about one preference for further editing.
+
+Data that is put on stash: preference_meta, provisioning_domain_id, preference, preference_values
+
+=head2 preferences_edit
+
+Use a form for editing one preference. Execute the changes that are posted.
+
+Data that is put on stash: edit_preference, form
+
+=head2 load_preference_list
+
+Retrieves and processes a datastructure containing preference groups, preferences and their values, to be used in rendering the preference list.
+
+Data that is put on stash: pref_groups
+
 =head1 AUTHOR
 
 Andreas Granig,,,
@@ -337,8 +397,4 @@ it under the same terms as Perl itself.
 
 =cut
 
-__PACKAGE__->meta->make_immutable;
-
-1;
-
 # vim: set tabstop=4 expandtab:

lib/NGCP/Panel/Form/Preferences.pm

@@ -106,4 +106,44 @@ sub create_structure {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+NGCP::Panel::Form::Preferences
+
+=head1 DESCRIPTION
+
+Preferences Form.
+
+=head1 METHODS
+
+=head2 build_render_list
+
+Specifies the order, form elements are rendered.
+
+=head2 build_form_element_class
+
+for styling
+
+=head2 field_list
+
+This is automatically called by the constructor, it allows you to create a number of fields that should be created.
+
+=head2 create_structure
+
+The field list given to this method will be rendered.
+
+=head1 AUTHOR
+
+Gerhard Jungwirth
+
+=head1 LICENSE
+
+This library is free software. You can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=cut
+
 # vim: set tabstop=4 expandtab: