Commit Graph

19 Commits (5f8264dddb0ded5f0e039bc50c02fb2a2c8cfbb2)

Author SHA1 Message Date
Mauricio Carneiro 321afac4e8 Updates to the help layout.
*New style.css, new template for the walker auto-generated html. Short description is no longer repeated in the long description of the walker.

 *Updated DiffObjectsWalker and ContigStatsWalker as "reference" documented walkers.
2011-07-26 19:29:25 -04:00
Mark DePristo 2039ce6102 Default values now displayed in arguments
DiffEngine fixed so that newInstance() would work.  Pretty quickly encountered a situation where newInstance() failed.  Debug output now written when this occurs in the log.
Logger now used instead of standard out, with INFO the default level.
2011-07-24 22:56:55 -04:00
Mark DePristo 7b84347047 Main index is sorted by the template now. 2011-07-24 18:19:40 -04:00
Mark DePristo 83996f7951 Enumerated types are working. 2011-07-24 18:14:21 -04:00
Mark DePristo 3c34e9fa65 Cleanup emuns and tables 2011-07-24 17:45:58 -04:00
Mark DePristo c620d96c96 Inline enum documentation is working 2011-07-24 17:22:14 -04:00
Mark DePristo 793e7d3d1d Improved header and argument details
Argument detail structure cleaned up. Only relevant pieces of information are shown now, and in a cleaner layout.
Misc. cleanup in the code.
2011-07-24 16:36:25 -04:00
Mark DePristo c6af4efcdc Implemented see also and version header 2011-07-24 16:10:17 -04:00
Mark DePristo b8db0510e0 Sytle sheet and common functions 2011-07-24 15:43:23 -04:00
Mark DePristo 5e0fe2d0f9 Support for style.css via refactored common.html included in all files 2011-07-24 15:42:39 -04:00
Mark DePristo d0ab6bf7a9 Now links to sub and superclass documentation, where possible. 2011-07-24 09:56:17 -04:00
Mark DePristo 7420ed098e Semi-working version of extraDocs tag in annotation to refer to one capability being accessible in another
Required a significant refactoring of the GATKDoclet, which now has a unified place where the ClassDoc, class, annotation, and handler are all stored together.
2011-07-23 22:07:30 -04:00
Mark DePristo e262f4e10b gatkdoc now generalized to use @Annotation. Multiple subsystems now use annotation to receive docs
Index expanded to use summary() annotation field
UserExceptions, ReadFilters, GATK engine all use the system to generate docs
Doclet expanded to handle lots of new cases
2011-07-23 20:00:35 -04:00
Mark DePristo f0be7348be Generalized handler to allow it to be used with any arbitrary class structure.
DocumentedGATKFeature now includes a field for the group name.
Build.xml works with public / private now.
2011-07-22 14:07:40 -04:00
Mark DePristo 453954182e Generalized the documentation system to use a class-specific annotation and processor.
Need to generalize and bug fix the system.  But at a high level it's working now.
2011-07-22 13:18:33 -04:00
Mark DePristo e922ebc29d Missed this template for walker index. 2011-07-22 09:13:33 -04:00
Mark DePristo 81d0cab27e Walker index html now emited. 2011-07-21 16:01:54 -04:00
Mark DePristo e892489696 V2 of the document system.
Now uses GATKDoc class to organize documentation for arguments.
Arguments now listed by feature (required, optional, hidden, etc) and link to detailed information about the argument in the html
Lots of code moving between Class and ClassDoc objects.  Should be refactored into a single static utility class.
2011-07-21 15:20:34 -04:00
Mark DePristo 6fa17d86ae Completely hacked together version of a FreeMarker + javadoc + custom doclet walker documentation generator 2011-07-21 00:18:07 -04:00