| | 1 | = Doc Generator = |
| | 2 | |
| | 3 | You 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 | |
| | 8 | cobra -document <files> |
| | 9 | cobra -doc <files> |
| | 10 | cobra -doc-lib:<library> |
| | 11 | |
| | 12 | # examples |
| | 13 | |
| | 14 | cobra -doc MyApp.cobra Foo.cobra Bar.cobra |
| | 15 | cobra -doc -files:source-files.text |
| | 16 | |
| | 17 | cobra -doc-lib:Cobra.Core |
| | 18 | cobra -doc-lib:System |
| | 19 | cobra -doc-lib:System.Core |
| | 20 | cobra -doc-lib:System.Web |
| | 21 | cobra -doc-lib:mscorlib |
| | 22 | }}} |
| | 23 | |
| | 24 | The 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 | |
| | 28 | There is not yet a standard for formatting, see-also, etc. |
| | 29 | |
| | 30 | There 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 |
