Changes between Version 10 and Version 11 of doc/tec/developerrules/palmstandard

Timestamp:

Nov 6, 2018 6:09:46 PM (6 years ago)

Author:

kanani

Comment:

--

doc/tec/developerrules/palmstandard

@@ -105 +105 @@
 
 == Commenting & documentation ==
-Documentation consists of putting information both inside and outside the source code.
-Comments should give a good idea of what the code does and where to look for any special activity.
+Documentation consists of putting information both internally and externally of the source code. Comments should give a good idea of what the code does and where to look for any special activity. PALM supports the use of Doxygen, a tool for generating documentation and flow charts from annotated source code. This requires some special formatting, as described below.
 
-'''Doxygen format'''
+'''File header section'''
+* todos, notes, author,....
 * Declaration !< Description
 * see file header
 * @author etc.
 * MODULE/SUBROUTINE description !>
-
-'''Header section'''
-* todos, notes, author,....
 
 '''Inside the code'''
@@ -125 +122 @@
 
 '''Outside the code'''
+You are in the middle of it. We have an extensive online documentation wiki embedded into a [link-to trac] project management system, directly connected to the svn repository, allowing to [browse the PALM code] @ all its former and of course current revision in a web-based environment.
+Your carefully developed code can only be used, if there is a documentation that tells the PALM user how to use and steer the feature.
 
 = (X) Coding =