Platon Technologies
not logged in Login Registration
EnglishSlovak
open source software development celebrating 10 years of open source development! Friday, October 16, 2026
[BACK] [TXT][DIR] Up to [Platon] / doc / soft-doc-sys / sgml / en

Diff for doc/soft-doc-sys/sgml/en/developer-doc-systems.sgml between version 1.3 and 1.4

version 1.3, 2002/12/16 18:02:22 version 1.4, 2002/12/17 22:34:01
Line 1 
Line 1 
 <!-- $Platon: Platon.SK/doc-projects/soft-doc-sys/en/developer-doc-systems.sgml,v 1.2 2002/12/11 18:16:12 nepto Exp $ -->  <!-- $Platon: Platon.SK/doc-projects/soft-doc-sys/en/developer-doc-systems.sgml,v 1.3 2002/12/16 18:02:22 nepto Exp $ -->
   
 <chapter id="developer-doc-sys">  <chapter id="developer-doc-sys">
 <title>Developer-oriented software documentation systems</title>  <title>Developer-oriented software documentation systems</title>
Line 68  example for <productname>Doxygen</>.
Line 68  example for <productname>Doxygen</>.
 </para>  </para>
 <para>  <para>
   
 <example>  <example id="developer-doc-sys.doxygen-example">
 <title>Documented <acronym>C++</> source code for <productname>Doxygen</></title>  <title>Documented <acronym>C++</> source code for <productname>Doxygen</></title>
 <programlisting><![CDATA[  <programlisting><![CDATA[
 /**  /**
Line 101  class Example
Line 101  class Example
 ]]></programlisting>  ]]></programlisting>
 </example>  </example>
   
 <example>  <example id="developer-doc-sys.peardoc-example">
 <title>Documented <acronym>PHP</> source code for <productname>PearDoc</></title>  <title>Documented <acronym>PHP</> source code for <productname>PearDoc</></title>
 <programlisting><![CDATA[  <programlisting><![CDATA[
 /**  /**
Line 131  class Example
Line 131  class Example
 ]]></programlisting>  ]]></programlisting>
 </example>  </example>
   
 <example>  <example id="developer-doc-sys.javadoc-example">
 <title>Documented <acronym>Java</> source code for <productname>JavaDoc</></title>  <title>Documented <acronym>Java</> source code for <productname>JavaDoc</></title>
 <programlisting><![CDATA[  <programlisting><![CDATA[
 /**  /**
Line 185  reference (address). Other universally u
Line 185  reference (address). Other universally u
 <member> &nbsp; <token>@author</></><member> -- author of the entity (class, method, function)</>  <member> &nbsp; <token>@author</></><member> -- author of the entity (class, method, function)</>
 <member> &nbsp; <token>@version</></><member> -- version of the entity</>  <member> &nbsp; <token>@version</></><member> -- version of the entity</>
 <member> &nbsp; <token>@date</></><member> -- date of creation</>  <member> &nbsp; <token>@date</></><member> -- date of creation</>
 <member> &nbsp; <token>@since</></><member> -- minimum version having  <member> &nbsp; <token>@since</></><member> -- minimum version having some functionality</>
 functionality (TODO)</>  <member> &nbsp; <token>@deprecated</></><member> -- old and now unsupported functionality</>
 <member> &nbsp; <token>@deprecated</></><member> -- TODO</>  
 <member> &nbsp; <token>@see</></><member> -- reference to the corresponding entities</>  <member> &nbsp; <token>@see</></><member> -- reference to the corresponding entities</>
 <member> &nbsp; <token>@todo</></><member> -- list of unfinished features</>  <member> &nbsp; <token>@todo</></><member> -- list of unfinished features</>
 </simplelist>  </simplelist>
Line 195  functionality (TODO)</>
Line 194  functionality (TODO)</>
 </para>  </para>
 <para>  <para>
   
 <example>  <example id="developer-doc-sys.advanced-example">
 <title>Use of other documentation marks</title>  <title>Use of other documentation marks</title>
 <programlisting><![CDATA[  <programlisting><![CDATA[
 /**  /**
Line 205  functionality (TODO)</>
Line 204  functionality (TODO)</>
  *   *
  * @author     Ondrej Jombik <nepto@pobox.sk>   * @author     Ondrej Jombik <nepto@pobox.sk>
  * @author     Ondrej Holotnak <beast@host.sk>   * @author     Ondrej Holotnak <beast@host.sk>
  * @version    1.0   * @version    ]]>&version;<![CDATA[
  * @date       2002-12-11   * @date       ]]>&name;<![CDATA[
  */   */
 class Extensive_Example  class Extensive_Example
 {  {
Line 236  generate the final documentation in seve
Line 235  generate the final documentation in seve
 manual pages.  It is all configured using a well-defined configuration file  manual pages.  It is all configured using a well-defined configuration file
 <filename>Doxyfile</>.  If you run the <command>doxygen</> program with  <filename>Doxyfile</>.  If you run the <command>doxygen</> program with
 <option>-g</> switch, the default configuration file will be written to disk.  <option>-g</> switch, the default configuration file will be written to disk.
 It includes a lot of comments, so it.s modification is simple and  It includes a lot of comments, so its modification is simple and
 straightforward.  The final document can be generated with the following  straightforward.  The final document can be generated with the following
 command:  command:
   
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.4
Platon Group <platon@platon.org> http://platon.org/
Copyright © 2002-2006 Platon Group
Site powered by Metafox CMS 		Go to Top