Wiki

Changes between Initial Version and Version 1 of DocGenerator

Show
Ignore:
Timestamp:
05/28/13 20:49:16 (4 years ago)
Author:
Charles
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DocGenerator

    v1 v1  
     1= Doc Generator = 
     2 
     3You can generate HTML API docs from Cobra source code with the -document/-doc option, and from libraries with -doc-lib. 
     4 
     5{{{ 
     6# general form 
     7 
     8cobra -document <files> 
     9cobra -doc <files> 
     10cobra -doc-lib:<library> 
     11 
     12# examples 
     13 
     14cobra -doc MyApp.cobra Foo.cobra Bar.cobra 
     15cobra -doc -files:source-files.text 
     16 
     17cobra -doc-lib:Cobra.Core 
     18cobra -doc-lib:System 
     19cobra -doc-lib:System.Core 
     20cobra -doc-lib:System.Web 
     21cobra -doc-lib:mscorlib 
     22}}} 
     23 
     24The files end up in a subdirectory called gen-docs/ with one file per type/class and an index.html to list them all. 
     25 
     26== Notes == 
     27 
     28There is not yet a standard for formatting, see-also, etc. 
     29 
     30There are numerous outstanding improvements that could be made to both formatting and navigation. See HelpWanted for more information. 
     31 
     32== See Also == 
     33 
     34 * HelpDirective 
     35 * CommandLine 
     36 * HelpWanted