Howto - Revision history

137.229.24.50 at 21:11, 14 January 2009

2009-01-14T21:11:11Z

137.229.24.222: /* How to do sh2doc comments */

2009-01-09T01:45:16Z

‎How to do sh2doc comments

137.229.24.222: /* How to do sh2doc comments */

2009-01-09T01:44:51Z

‎How to do sh2doc comments

137.229.24.222: /* How to do sh2doc comments */

2009-01-09T01:43:47Z

‎How to do sh2doc comments

137.229.24.222: /* How to do sh2doc comments */

2009-01-09T01:43:01Z

‎How to do sh2doc comments

137.229.24.222: /* How to do sh2doc comments */

2009-01-09T01:41:14Z

‎How to do sh2doc comments

137.229.24.222 at 01:14, 9 January 2009

2009-01-09T01:14:33Z

Tfour: /* How to do Shell */

2008-06-25T16:04:32Z

‎How to do Shell

Ronni: /* ... and NetCDF? */

2008-06-12T00:54:36Z

‎... and NetCDF?

Ronni: /* ... and NetCDF? */

2008-06-12T00:53:20Z

‎... and NetCDF?

← Older revision		Revision as of 21:11, 14 January 2009
Line 187:		Line 187:

	Quit screen, this closes all screens.		Quit screen, this closes all screens.
−
−	~~==How to do GMT==~~
−	~~==How to do CrusDe==~~

@@ Line 78: / Line 78: @@
 </pre>
-Each line followed by that special comment will be added to the DETAILS section preceded by '=&gt;' to mark it as a somewhat 'additional note'. This way you can describe the actual flow of the code right where things happen. Note that you can use HTML formatting within the comments, but do not include empty lines when you are trying to improve readability. Also keep in mind that the comments should be clear when you look at the [[http://www.gps.alaska.edu/internal/index.php/Special:Call/Include_code,/export/ftpweb/htdocs/sh2doc/sh2doc.pl/|code]], so don't overdo the whole table thing.
+Each line followed by that special comment will be added to the DETAILS section preceded by '=&gt;' to mark it as a somewhat 'additional note'. This way you can describe the actual flow of the code right where things happen. Note that you can use HTML formatting within the comments, but do not include empty lines when you are trying to improve readability. Also keep in mind that the comments should be clear when you look at the [[Special:Call/Include_code,/export/ftpweb/htdocs/sh2doc/sh2doc.pl/|code]], so don't overdo the whole table thing.
 ==How to do Matlab==

@@ Line 78: / Line 78: @@
 </pre>
-Each line followed by that special comment will be added to the DETAILS section preceded by '=&gt;' to mark it as a somewhat 'additional note'. This way you can describe the actual flow of the code right where things happen. Note that you can use HTML formatting within the comments, but do not include empty lines when you are trying to improve readability. Also keep in mind that the comments should be clear when you look at the code, so don't overdo the whole table thing.
+Each line followed by that special comment will be added to the DETAILS section preceded by '=&gt;' to mark it as a somewhat 'additional note'. This way you can describe the actual flow of the code right where things happen. Note that you can use HTML formatting within the comments, but do not include empty lines when you are trying to improve readability. Also keep in mind that the comments should be clear when you look at the [[http://www.gps.alaska.edu/internal/index.php/Special:Call/Include_code,/export/ftpweb/htdocs/sh2doc/sh2doc.pl/|code]], so don't overdo the whole table thing.
 ==How to do Matlab==

@@ Line 12: / Line 12: @@
 </pre>
-The keyword <code>##BRIEF<code> should be followed by a short one-liner that explains the main functionality of the code. This information goes
+The keyword <code>##BRIEF</code> should be followed by a short one-liner that explains the main functionality of the code. This information goes
 into the [[Shell scripts|overview table]] where all scripts are listed. All the rest following below will end up on a separate page, e.g.
 [[Special:Call/Include_info,/export/ftpweb/htdocs/sh2doc/sh2doc.pl.html]].
@@ Line 23: / Line 23: @@
 </pre>
-Well, give a name in the line after  <code>##AUTHOR<code> - preferably your own - so there is someone to blame in case something goes wrong.
+Well, give a name in the line after  <code>##AUTHOR</code> - preferably your own - so there is someone to blame in case something goes wrong.
 <pre>
@@ Line 31: / Line 31: @@
 </pre>
-Give the date of creation in the line following the keyword <code>##DATE<code>.
+Give the date of creation in the line following the keyword <code>##DATE</code>.
 <pre>
@@ Line 57: / Line 57: @@
 </pre>
-Following the keyword <code>##DETAILS<code> you can give all the information about the code you want anyone to have. Being chatty at this
+Following the keyword <code>##DETAILS</code> you can give all the information about the code you want anyone to have. Being chatty at this
 point is adviced. And here you should actually read the comment above since it describes what's going on.

@@ Line 78: / Line 78: @@
 </pre>
-Each line followed by that special comment will be added to the DETAILS section preceded by '=&gt;' to mark it as a somewhat 'additional note'. This way you can describe the actual flow of the code right where things happen.
+Each line followed by that special comment will be added to the DETAILS section preceded by '=&gt;' to mark it as a somewhat 'additional note'. This way you can describe the actual flow of the code right where things happen. Note that you can use HTML formatting within the comments, but do not include empty lines when you are trying to improve readability. Also keep in mind that the comments should be clear when you look at the code, so don't overdo the whole table thing.
 ==How to do Matlab==

@@ Line 1: / Line 1: @@
 ==How to do sh2doc comments==
-We have the tool sh2doc that looks through the shell/perl scripts to automatically compile an overview of the existing tools we got, especially for GPS processing. The current result is published on the [[Shell scripts]] page. Everybody editing, creating or using a certain script should make sure to follow a few basic rules to make this a valuable documentation of our toolbox. The documentation of <code>/usr/local/sh2doc/sh2doc.pl</code> shows the possibilities:
+We have the tool sh2doc that looks through the shell/perl scripts to automatically compile an overview of the existing tools we got, especially for GPS processing. The current result is published on the [[Shell scripts]] page. Everybody editing, creating or using a certain script should make sure to follow a few basic rules to make this a valuable documentation of our toolbox. The sample for my explanations are the comments within the parser itself (<code>/usr/local/sh2doc/sh2doc.pl</code>).
 <pre>
@@ Line 6: / Line 8: @@
+#
 ##BRIEF
-#Script for automatic documentation
+# Script for automatic documentation shell scripts
-#of gipsy add-on scripts
+#
 ##AUTHOR
 # Ronni Grapenthin
+#
 ##DATE
 # 2007-11-20
+#
 ##DETAILS
+#
@@ Line 36: / Line 55: @@
 # breaks. </p>
+#
 ##CHANGELOG
+#
@@ Line 42: / Line 67: @@
 # 2009-01-08 (ronni): some cheap hacks with the links to get this included in the wiki, a clean html-non-wiki-version is necessary<br>
+#
 </pre>
 ==How to do Matlab==

← Older revision		Revision as of 01:14, 9 January 2009
Line 1:		Line 1:
		+	==How to do sh2doc comments==
		+	We have the tool sh2doc that looks through the shell/perl scripts to automatically compile an overview of the existing tools we got, especially for GPS processing. The current result is published on the [[Shell scripts]] page. Everybody editing, creating or using a certain script should make sure to follow a few basic rules to make this a valuable documentation of our toolbox. The documentation of <code>/usr/local/sh2doc/sh2doc.pl</code> shows the possibilities:
		+
		+	<pre>
		+	#!/usr/bin/perl
		+	#
		+	##BRIEF
		+	#Script for automatic documentation
		+	#of gipsy add-on scripts
		+	#
		+	##AUTHOR
		+	# Ronni Grapenthin
		+	#
		+	##DATE
		+	# 2007-11-20
		+	#
		+	##DETAILS
		+	#
		+	# This script runs though all directories specified in the field @DIRS and
		+	# looks at all files whether they contain special documentation makers like:
		+	# <ul>
		+	# <li>##BRIEF</li>
		+	# <li>##AUTHOR</li>
		+	# <li>##DETAILS</li>
		+	# <li>##DATE</li>
		+	# <li>##CHANGELOG</li>
		+	# </ul>
		+	# If any of these are found, the file is added to an overview contained in an
		+	# index.html file which lists file name (and a link to a detailed description).
		+	# Furthermore another HTML file is created which contains detailed information
		+	# of the file given in the documentation. Additional meta data of the file such as
		+	# last changed could be added.<br/>
		+	# A line that (starts with spaces only and) contains a comment starting with '#+#'
		+	# will be added to the details. <p>Empty lines or "##" denote that the subsection
		+	# (e.g. DETAILS) is finished. So use minimal HTML for paragraph formatting and line
		+	# breaks. </p>
		+	#
		+	##CHANGELOG
		+	#
		+	# 2008-01-28 (ronni): search for executables, includes non-tagged files / binaries in index.<br>
		+	# 2008-01-29 (ronni): sorts filenames, gives separate tables for each letter<br>
		+	# 2009-01-08 (ronni): some cheap hacks with the links to get this included in the wiki, a clean html-non-wiki-version is necessary<br>
		+	#
		+
		+	</pre>
		+
	==How to do Matlab==		==How to do Matlab==
	=== ... batch processing? ===		=== ... batch processing? ===

@@ Line 59: / Line 59: @@
 to find other operators you would want to use. For
 more sophisticated math you would wanna use awk or Perl scripts.
 ==How to do GMT==
 ==How to do CrusDe==

@@ Line 14: / Line 14: @@
 === ... and NetCDF? ===
-The MEXNC, SNCTOOLS and toolsUI packages are installed in </code>/usr/local/matlab</code> . A tutorial describes which routines are
+The MEXNC, SNCTOOLS and toolsUI packages are installed in <code>/usr/local/matlab</code> . A tutorial describes which routines are
 provided by the SNCTOOLS package: [http://mexcdf.sourceforge.net/tutorial/index.html http://mexcdf.sourceforge.net/tutorial/index.html].
 To make use of those, you might have to alter your path: