From 61bfe2d70cae6be8c4086a210a5451135ccca9ea Mon Sep 17 00:00:00 2001 From: Magnus Auvinen Date: Sat, 2 Aug 2008 08:21:29 +0000 Subject: added doc tool --- docs/tool/Help/documenting.html | 58 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 docs/tool/Help/documenting.html (limited to 'docs/tool/Help/documenting.html') diff --git a/docs/tool/Help/documenting.html b/docs/tool/Help/documenting.html new file mode 100644 index 00000000..2999f431 --- /dev/null +++ b/docs/tool/Help/documenting.html @@ -0,0 +1,58 @@ + + +Documenting Your Code - Natural Docs + + + +
Natural Docs
About
Language SupportOutput Formats
Using
Documenting
Your CodeKeywordsRunningTroubleshooting
Customizing
Organizing the MenuCSS StylesTopics and KeywordsLanguages, Indexes,
and Prototypes
Community
Web SiteMailing ListsMessage BoardsBugs and
Feature Requests
Documenting Your Code
Walkthrough
Reference

Here’s a quick example of how to document your code for Natural Docs.  If you’re a new user, we have a walkthrough to get you started.  Otherwise, visit the reference for the full details.

/*
+   Function: Multiply
+
+   Multiplies two integers.
+
+   Parameters:
+
+      x - The first integer.
+      y - The second integer.
+
+   Returns:
+
+      The two integers multiplied together.
+
+   See Also:
+
+      <Divide>
+*/
+int Multiply (int x, int y)
+   {  return x * y;  };
Copyright © 2003-2008 Greg Valure
\ No newline at end of file -- cgit 1.4.1