Modules - Revision history

Kgoetz: Change category Developer to Contribute

2018-09-11T23:52:50Z

Change category Developer to Contribute

Pm705 at 16:31, 8 February 2010

2010-02-08T16:31:56Z

Kiz: /* Private Methods */

2009-08-12T09:50:24Z

‎Private Methods

Kiz: /* Private Methods */

2009-08-12T09:48:17Z

‎Private Methods

Kiz: /* General */

2009-08-12T09:31:11Z

‎General

Kiz: /* Public Methods */

2009-08-10T12:09:56Z

‎Public Methods

Kiz at 12:01, 10 August 2009

2009-08-10T12:01:57Z

Kiz: New page: Below the license block the name, description and synopsis (a synopsis is an example of usage). Lastly the METHODS title begins the section for inline subroutine documentation.

 	=h...

2009-08-10T12:00:56Z

New page: Below the license block the name, description and synopsis (a synopsis is an example of usage). Lastly the METHODS title begins the section for inline subroutine documentation. <pre> =h...

New page

Below the license block the name, description and synopsis (a synopsis is an example of usage). Lastly the METHODS title begins the section for inline subroutine documentation.
<pre>
=head1 NAME

EPrints::MyModule - A one line description of MyModule

=head1 DESCRIPTION

One or two paragraphs explaining the function of EPrints::MyModule.

=head1 SYNOPSIS

use EPrints::MyModule;

my $obj = EPrints::MyModule->new( $opts );
$obj->do_thing( $thingy );

=head1 METHODS

=over 4

=cut
</pre>
==Methods==
===Public Methods===
Each public subroutine should have POD documentation above it, with hashes to
separate it from the method above. A large module should probably be split into
different sections, e.g. "CONSTRUCTOR METHODS", "ACCESSOR METHODS", etc.
Private methods can be documented using Perl comments.
<pre>
######################################################################

=item $objname = EPrints::StyleGuide->my_sub( $arg1, [$opt_arg2], \%opts )

A description of what my_sub does and arguments it takes ($opt_arg2 is
shown as optional by using brackets).

A description of $arg1 if needed, along with an example:

EPrints::StyleGuide->my_sub( "eprintid" );

EPrints::StyleGuide->my_sub(
$arg1,
undef,
{
opt1 => $var1, # What is var1
opt2 => $var2, # What is var2
}
);

Further elaboration on the effect of $var2.

=cut

######################################################################

sub my_sub
{
...
}
</pre>
===Private Methods===

← Older revision		Revision as of 23:52, 11 September 2018
Line 1:		Line 1:
−	~~[[Category:Developer]]~~
	[[Category:Contribute]]		[[Category:Contribute]]
	==General==		==General==

← Older revision		Revision as of 16:31, 8 February 2010
Line 1:		Line 1:
		+	[[Category:Developer]]
		+	[[Category:Contribute]]
	==General==		==General==
	Please write your code to the general [[http://wiki.eprints.org/w/StyleGuide StyleGuide]] of EPrints		Please write your code to the general [[http://wiki.eprints.org/w/StyleGuide StyleGuide]] of EPrints

← Older revision		Revision as of 09:48, 12 August 2009
Line 69:		Line 69:

	===Private Methods===		===Private Methods===
		+	<pre>
		+	######################################################################
		+	#
		+	# $id = $session->_find_foo
		+	#
		+	# This is where we do some clever stuff, and find the foo in the bar
		+	# (or, failing that, have a wee drink in the bar, before going back to
		+	# work!
		+	#
		+	######################################################################
		+	sub _find_foo
		+	{
		+	my( $self ) = @_;
		+
		+	my $sesh = $self->{session};
		+
		+	# mix it up, slosh it around... define $whatever
		+
		+	return $whatever
		+
		+	}
		+	</pre>

← Older revision		Revision as of 12:01, 10 August 2009
Line 1:		Line 1:
−		+	==General==
		+	Please write your code to the general [[http://wiki.eprints.org/w/StyleGuide StyleGuide]] of EPrints

	Below the license block the name, description and synopsis (a synopsis is an example of usage). Lastly the METHODS title begins the section for inline subroutine documentation.		Below the license block the name, description and synopsis (a synopsis is an example of usage). Lastly the METHODS title begins the section for inline subroutine documentation.

@@ Line 69: / Line 69: @@
 ===Private Methods===
 <pre>
 ######################################################################

@@ Line 2: / Line 2: @@
 Please write your code to the general [[http://wiki.eprints.org/w/StyleGuide StyleGuide]] of EPrints
-Below the license block the name, description and synopsis (a synopsis is an example of usage). Lastly the METHODS title begins the section for inline subroutine documentation.
+Below the license block, you need to document the name, description and synopsis (a synopsis is an example of usage) of the Package.
 <pre>
 	=head1 NAME
@@ Line 25: / Line 25: @@
 	=cut
 </pre>
 ==Methods==
 ===Public Methods===

@@ Line 33: / Line 33: @@
 <pre>
 	######################################################################
 	=item $objname = EPrints::StyleGuide->my_sub( $arg1, [$opt_arg2], \%opts )
@@ Line 63: / Line 64: @@
+	}
 </pre>
 ===Private Methods===