GENIE Using NaturalDocs - Revision history

Genie-user: /* Intro */ make doc -> make docs

2008-10-09T18:11:35Z

Intro: make doc -> make docs

2007-07-18T09:37:51Z

Intro

2007-04-04T16:55:55Z

2007-04-04T16:24:41Z

Quickstart

2007-04-04T16:24:13Z

2007-04-04T16:22:19Z

2007-04-04T16:21:23Z

Intro

2007-04-04T16:20:17Z

Intro

2007-04-04T16:14:42Z

Quickstart

2007-04-04T16:09:48Z

Quickstart

@@ Line 1: / Line 1: @@
 ==Intro==
-NaturalDocs (http://www.naturaldocs.org/) is a very useful package that turns ordinary code comments into professional looking HTML documentation.  In GENIE, if you type '''make doc''', NaturalDocs will scan the whole repository for suitable comments and do the do.  See '''genie-main/doc/index.html''' for the result.
+NaturalDocs (http://www.naturaldocs.org/) is a very useful package that turns ordinary code comments into professional looking HTML documentation.  In GENIE, if you type '''make docs''' when in genie-main, NaturalDocs will scan the whole repository for suitable comments and do the do.  See '''genie-main/doc/index.html''' for the result.
 Rest assured, NaturalDocs '''will not''', I'll repeat that, '''will not''' drag every murky comment you make kicking and screaming out into the lime light.  Your comments need to be in a particular format.  Happily, this format is far from onerous and is, in fact, very ''natural'' (your saying "ah" about now..).  The section below shows just how easy using NaturalDocs can be.

@@ Line 3: / Line 3: @@
 NaturalDocs (http://www.naturaldocs.org/) is a very useful package that turns ordinary code comments into professional looking HTML documentation.  In GENIE, if you type '''make doc''', NaturalDocs will scan the whole repository for suitable comments and do the do.  See '''genie-main/doc/index.html''' for the result.
-Rest assured, NaturalDocs '''will not''', I'll repeat that, '''will not''' drag every murky comment you make kiccking and screaming out into the lime light.  Your comments need to be in a particular format.  Happily, this format is far from onerous and is, in fact, very ''natural'' (your saying "ah" about now..).  The section below shows just how easy using NaturalDocs can be.
+Rest assured, NaturalDocs '''will not''', I'll repeat that, '''will not''' drag every murky comment you make kicking and screaming out into the lime light.  Your comments need to be in a particular format.  Happily, this format is far from onerous and is, in fact, very ''natural'' (your saying "ah" about now..).  The section below shows just how easy using NaturalDocs can be.
 ==Quickstart==

← Older revision		Revision as of 16:55, 4 April 2007
Line 53:		Line 53:

	To learn more about making your comments compatible, go to http://www.naturaldocs.org/documenting.html, especially the page showing which keywords you can use, http://www.naturaldocs.org/keywords.html.		To learn more about making your comments compatible, go to http://www.naturaldocs.org/documenting.html, especially the page showing which keywords you can use, http://www.naturaldocs.org/keywords.html.
		+
		+	==What it looks like==
		+
		+	[[Image:NaturalDocs2.JPG\|frame\|centre\|Professional quality documentaion from NaturalDocs]]

@@ Line 7: / Line 7: @@
 ==Quickstart==
-Here is a quick and simple example showing how you immediately get going using NaturalDocs:
+Here is a quick and easy example showing how you can immediately get going using NaturalDocs:
 <pre>

@@ Line 3: / Line 3: @@
 NaturalDocs (http://www.naturaldocs.org/) is a very useful package that turns ordinary code comments into professional looking HTML documentation.  In GENIE, if you type '''make doc''', NaturalDocs will scan the whole repository for suitable comments and do the do.  See '''genie-main/doc/index.html''' for the result.
-Rest assured, NaturalDocs '''will not''', I'll repeat that, '''will not''' darg every murky comment out into the lime light.  Your comments need to be of a particular format.  Happily, this format is far from onerous and is, in fact, very natural (hence the name).  The section below shows just how easy using NaturalDocs can be.
+Rest assured, NaturalDocs '''will not''', I'll repeat that, '''will not''' drag every murky comment you make kiccking and screaming out into the lime light.  Your comments need to be in a particular format.  Happily, this format is far from onerous and is, in fact, very ''natural'' (your saying "ah" about now..).  The section below shows just how easy using NaturalDocs can be.
 ==Quickstart==

← Older revision		Revision as of 16:20, 4 April 2007
Line 1:		Line 1:
	==Intro==		==Intro==
		+
		+	NaturalDocs (http://www.naturaldocs.org/) is a very useful package that turns fairl ordinary code comments into professional looking HTML documentation. In GENIE, if you type '''make doc''', NaturalDocs will scan the whole repository for suitable comments and create a set of documenting HTML pages. See '''genie-main/doc/index.html''' for the result.
		+
		+	Rest assured, NaturalDocs '''will not''', I'll repeat that, '''will not''' darg every murky comment out into the lime light. Your comments need to be of a particular format. Happily, this format is far from onerous and is, in fact, very natural (hence the name). The section below shows just how easy using NaturalDocs can be.

	==Quickstart==		==Quickstart==

← Older revision		Revision as of 16:14, 4 April 2007
Line 47:		Line 47:
	end MODULE		end MODULE
	</pre>		</pre>
		+
		+	To learn more about making your comments compatible, go to http://www.naturaldocs.org/documenting.html, especially the page showing which keywords you can use, http://www.naturaldocs.org/keywords.html.

@@ Line 19: / Line 19: @@
    integer :: koverall
-   !  Subroutine: Multiply
+   contains:
-  subroutine Multiply (x, y, z)
+    !  Subroutine: Multiply
-     integer, intent(in)  :: x
+     subroutine Multiply (x, y, z)
-    integer, intent(in)  :: y
-    integer, intent(out) :: z
+      integer, intent(in)  :: x
-    z = x * y
+      z = x * y
-  end subroutine
+    end subroutine
 end MODULE
 </pre>