89a581a66f
Added ability to specify arguments in files via -args/--arg_file
...
Pushing back downsample and read filter args so they show up in getApproximateCommandLineArgs()
2011-10-24 15:58:34 -04:00
a5006831d7
Shows "" not empty space when default string value is ""
2011-09-28 11:35:52 -04:00
1e32281a15
Fix to not show -null when missing short name argument
2011-09-28 11:31:20 -04:00
dfce301beb
Looks for @Hidden annotation on all classes and excludes them from the docs
2011-09-23 09:03:04 -04:00
8b3cfb2f1c
Final documented version of GATKDoclet and associated classes
...
-- Docs on everything.
-- Feature complete. At this point only minor improvements and bugfixes are anticipated
2011-08-19 16:52:17 -04:00
4d1fd17a97
GATKDoclet cleanup and documentation
...
-- Fixed bug in the way ArgumentCollections were handled that lead to failure in handling the dbsnp argument collection.
2011-08-19 13:13:41 -04:00
5fbdf968f7
ArgumentSource no longer comparable. Arguments sorted by GATKDoclet
2011-08-18 22:20:14 -04:00
d1892cd0d7
Bug fixes
...
-- Sorting of ArgumentSources now done in GATKDoclet, not in the ParsingEngine, as the system depends on the LinkedTreeMap
-- Fixed broken exception throwing in the case where a file's type could not be determined
2011-08-18 21:58:36 -04:00
c5efb6f40e
Usability improvements to GATKDocs
...
-- ArgumentSources are now sorted by case insensitive names, so arguments are shown in alphabetical order (Ryan)
-- @Advanced annotation can be used to indicate that an argument is an advanced option and should be visually deemphasized in the GATKs. There's now an advanced section. Mauricio or Ryan -- could you figure out how to make this section less prominent in the style.css?
2011-08-18 21:39:11 -04:00
f7414e39bc
Improvements to GATKDocs
...
-- Allowed values for RodBinding<T> are displayed in the GATKDocs
-- Longest name up to 30 characters is chosen for main argument list (suggested by Ryan/Mauricio)
-- Features are listed in alphabetical order
-- Moved useful getParameterizedType() function to JVMUtils
-- Tests of these features in the Documentation Test
2011-08-18 21:20:09 -04:00
faa3f8b6f6
Only concrete classes are now documented
2011-08-18 14:04:47 -04:00
5772766dd5
Improvements to GATKDocs
...
-- Now supports a static list of root classes / interfaces that should receive docs. A complementary approach to documenting features to the DocumentedGATKFeature annotation
-- Tribble codecs are now documented!
-- No longer displayed sub and super classes
2011-08-18 14:00:09 -04:00
e03db30ca0
New uses DocumentedGATKFeatureObject instead of annotation directly
...
-- Step 1 on the way to creating a static list of additional classes that we want to document.
2011-08-18 12:31:04 -04:00
cbec69a130
Merge branch 'master' into help
...
Conflicts:
public/java/src/org/broadinstitute/sting/utils/help/HelpUtils.java
2011-08-18 11:33:27 -04:00
f5d7cabb20
Fix for reintroducing an already solved problem.
2011-08-18 11:20:12 -04:00
2d41ba15a4
Vastly better Tribble help message
...
Here's a new example:
##### ERROR ------------------------------------------------------------------------------------------
##### ERROR A USER ERROR has occurred (version 1.1-520-g76495cd):
##### ERROR The invalid arguments or inputs must be corrected before the GATK can proceed
##### ERROR Please do not post this error to the GATK forum
##### ERROR
##### ERROR See the documentation (rerun with -h) for this tool to view allowable command-line arguments.
##### ERROR Visit our wiki for extensive documentation http://www.broadinstitute.org/gsa/wiki
##### ERROR Visit our forum to view answers to commonly asked questions http://getsatisfaction.com/gsa
##### ERROR
##### ERROR MESSAGE: Invalid command line: Failed to parse value /humgen/gsa-hpprojects/GATK/data/refGene_b37.filtered.sorted.txt for argument refSeqRodBinding. Message: Invalid command line: No tribble type was provided on the command line and the type of the file could not be determined dynamically. Please add an explicit type tag :TYPE listing the correct type from among the supported types:
##### ERROR Name FeatureType Documentation
##### ERROR BEAGLE BeagleFeature http://www.broadinstitute.org/gsa/gatkdocs/release/org_broadinstitute_sting_utils_codecs_beagle_BeagleCodec.html
##### ERROR BED BEDFeature http://www.broadinstitute.org/gsa/gatkdocs/release/org_broad_tribble_bed_BEDCodec.html
##### ERROR BEDTABLE TableFeature http://www.broadinstitute.org/gsa/gatkdocs/release/org_broadinstitute_sting_utils_codecs_table_BedTableCodec.html
##### ERROR CGVAR VariantContext http://www.broadinstitute.org/gsa/gatkdocs/release/org_broadinstitute_sting_utils_codecs_completegenomics_CGVarCodec.html
##### ERROR DBSNP DbSNPFeature http://www.broadinstitute.org/gsa/gatkdocs/release/org_broad_tribble_dbsnp_DbSNPCodec.html
##### ERROR GELITEXT GeliTextFeature http://www.broadinstitute.org/gsa/gatkdocs/release/org_broad_tribble_gelitext_GeliTextCodec.html
##### ERROR MAF MafFeature http://www.broadinstitute.org/gsa/gatkdocs/release/org_broadinstitute_sting_gatk_features_maf_MafCodec.html
##### ERROR MILLSDEVINE VariantContext http://www.broadinstitute.org/gsa/gatkdocs/release/org_broadinstitute_sting_utils_codecs_MillsDevineCodec.html
##### ERROR RAWHAPMAP RawHapMapFeature http://www.broadinstitute.org/gsa/gatkdocs/release/org_broadinstitute_sting_utils_codecs_hapmap_RawHapMapCodec.html
##### ERROR REFSEQ RefSeqFeature http://www.broadinstitute.org/gsa/gatkdocs/release/org_broadinstitute_sting_utils_codecs_refseq_RefSeqCodec.html
##### ERROR SAMPILEUP SAMPileupFeature http://www.broadinstitute.org/gsa/gatkdocs/release/org_broadinstitute_sting_utils_codecs_sampileup_SAMPileupCodec.html
##### ERROR SAMREAD SAMReadFeature http://www.broadinstitute.org/gsa/gatkdocs/release/org_broadinstitute_sting_utils_codecs_samread_SAMReadCodec.html
##### ERROR SNPEFF SnpEffFeature http://www.broadinstitute.org/gsa/gatkdocs/release/org_broadinstitute_sting_utils_codecs_snpEff_SnpEffCodec.html
##### ERROR SOAPSNP VariantContext http://www.broadinstitute.org/gsa/gatkdocs/release/org_broadinstitute_sting_utils_codecs_soapsnp_SoapSNPCodec.html
##### ERROR TABLE TableFeature http://www.broadinstitute.org/gsa/gatkdocs/release/org_broadinstitute_sting_utils_codecs_table_TableCodec.html
##### ERROR VCF VariantContext http://www.broadinstitute.org/gsa/gatkdocs/release/org_broadinstitute_sting_utils_codecs_vcf_VCFCodec.html
##### ERROR VCF3 VariantContext http://www.broadinstitute.org/gsa/gatkdocs/release/org_broadinstitute_sting_utils_codecs_vcf_VCF3Codec.html
##### ERROR ------------------------------------------------------------------------------------------
2011-08-18 10:31:32 -04:00
c30e1db744
Better location for help utils
2011-08-18 09:38:51 -04:00
125ad0bcfa
Added docs to RTC
2011-08-16 12:46:48 -04:00
2007d2fcad
Better documentation for default value fields
...
-- DocString function for types that create default outputs "stdout"
-- RodBinding now creates a makeUnbound default value automatically for you if your RodBinding isn't required
-- Removed warning about sparse help from TextFormattingUtils
2011-08-10 22:16:22 -04:00
0db79207e8
Refactored dependancy from CommandLineGATK from javadocs
...
This allows us to run the GATK again in environments without Javadoc loading by default in the classpath
2011-08-08 12:27:13 -04:00
5f8bc3aa8a
Documenting classes, and name cleanup
2011-08-07 15:17:50 -04:00
1c63d43176
Help now points to GATKDocs instead of spitting out full, garbled description
2011-08-07 15:02:46 -04:00
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
acda8eb09c
Commented out test that causes new CommandLineGATK() to fail
2011-07-25 12:43:27 -04:00
7f8e6a97ee
InfoFieldAnnotation now an abstract class extended by annotations so doc system works
2011-07-25 10:47:11 -04:00
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
c43b5981f2
Hidden variables are hidden by default. Settable by command line option
...
DiffObjectsWalker test arguments removed.
Minor refactoring of GATKDoclet
2011-07-24 20:52:44 -04:00
1c1f1da349
Fixing compilation
2011-07-24 20:01:59 -04:00
9f06f6c493
Split GATKDoclet from ResourceBundleDoclet. Refactored GaTKDocWorkUnit
2011-07-24 20:00:04 -04:00
83996f7951
Enumerated types are working.
2011-07-24 18:14:21 -04:00
3c34e9fa65
Cleanup emuns and tables
2011-07-24 17:45:58 -04:00
c620d96c96
Inline enum documentation is working
2011-07-24 17:22:14 -04:00
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
c6af4efcdc
Implemented see also and version header
2011-07-24 16:10:17 -04:00
5e0fe2d0f9
Support for style.css via refactored common.html included in all files
2011-07-24 15:42:39 -04:00
d0ab6bf7a9
Now links to sub and superclass documentation, where possible.
2011-07-24 09:56:17 -04:00
6b501e267b
Includes non-concrete classes in docs
...
CommandLineGATK has extraDocs to ReadFilter and UserException as well
2011-07-23 22:15:01 -04:00
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
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
28b9432d26
Docs for read filters, the engine, and the UserExceptions.
2011-07-22 16:09:21 -04:00
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
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
9e88d51db9
Removed now unused @version tags from walker docs.
2011-07-22 09:57:03 -04:00
421b70ca4f
Removed previous, and largely unused, help system extensions.
...
This involved deleting the utils/help/*Taglet.java classes, which parsed out these fields unnecessarily
This also involved removing the few uses of these from the codebase. For these uses, though, almost all were an identical copy of the first line of the docs, which is the default javadoc behavior anyway.
2011-07-22 09:42:44 -04:00
81d0cab27e
Walker index html now emited.
2011-07-21 16:01:54 -04:00
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
6fa17d86ae
Completely hacked together version of a FreeMarker + javadoc + custom doclet walker documentation generator
2011-07-21 00:18:07 -04:00
45c73ff0e5
Runs and emits an HTML document
2011-07-20 17:16:33 -04:00
9992c373be
Optimize imports run on the whole project, public and private. I just got too tired of all of the unused imports floating around. Confirmed that the system builds after the changes.
2011-07-17 20:29:58 -04:00
139c6b84a1
Modified build.xml and the help extractor doclet to use the output of "git
...
describe" as an absolute version number (if the repository has at least one
tag), using the raw SHA-1 hash value as a fallback version number in the case
where there are no tags.
2011-06-28 08:37:05 -04:00
Khalid Shakir
Mark DePristo
Eric Banks
Mauricio Carneiro
David Roazen