From 3a3ebbca0d1372b856d06a07932281c9ce390f48 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20G=C3=B3mez-S=C3=A1nchez?= Date: Tue, 6 Jun 2017 14:20:34 +0200 Subject: [PATCH 1/2] Make public getTagPrefix --- .../broadinstitute/barclay/help/DefaultDocWorkUnitHandler.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/broadinstitute/barclay/help/DefaultDocWorkUnitHandler.java b/src/main/java/org/broadinstitute/barclay/help/DefaultDocWorkUnitHandler.java index 2e024a4e..3c0bde72 100644 --- a/src/main/java/org/broadinstitute/barclay/help/DefaultDocWorkUnitHandler.java +++ b/src/main/java/org/broadinstitute/barclay/help/DefaultDocWorkUnitHandler.java @@ -329,7 +329,8 @@ protected void addCommandLineArgumentBindings(final DocWorkUnit currentWorkUnit, } } - private String getTagPrefix() { + /** Gets the tag prefix as formatted in the javadoc; {@code null} if there is no user-defined prefix. */ + public final String getTagPrefix() { String customPrefix = getTagFilterPrefix(); return customPrefix == null ? customPrefix : "@" + customPrefix + "."; From 80cc41dff92dab18db9f8dce96f6fa028fbcc145 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20G=C3=B3mez-S=C3=A1nchez?= Date: Tue, 6 Jun 2017 14:25:46 +0200 Subject: [PATCH 2/2] Add support for all kind of tags to look up for custom ones --- .../broadinstitute/barclay/help/DefaultDocWorkUnitHandler.java | 2 +- .../org/broadinstitute/barclay/help/TestArgumentContainer.java | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/broadinstitute/barclay/help/DefaultDocWorkUnitHandler.java b/src/main/java/org/broadinstitute/barclay/help/DefaultDocWorkUnitHandler.java index 3c0bde72..0aa54609 100644 --- a/src/main/java/org/broadinstitute/barclay/help/DefaultDocWorkUnitHandler.java +++ b/src/main/java/org/broadinstitute/barclay/help/DefaultDocWorkUnitHandler.java @@ -243,7 +243,7 @@ protected void addHighLevelBindings(final DocWorkUnit workUnit) */ protected void addCustomBindings(final DocWorkUnit currentWorkUnit) { final String tagFilterPrefix = getTagPrefix(); - Arrays.stream(currentWorkUnit.getClassDoc().inlineTags()) + Arrays.stream(currentWorkUnit.getClassDoc().tags()) .filter(t -> t.name().startsWith(tagFilterPrefix)) .forEach(t -> currentWorkUnit.setProperty(t.name().substring(tagFilterPrefix.length()), t.text())); } diff --git a/src/test/java/org/broadinstitute/barclay/help/TestArgumentContainer.java b/src/test/java/org/broadinstitute/barclay/help/TestArgumentContainer.java index a6147a5f..1f6ffbd1 100644 --- a/src/test/java/org/broadinstitute/barclay/help/TestArgumentContainer.java +++ b/src/test/java/org/broadinstitute/barclay/help/TestArgumentContainer.java @@ -23,6 +23,8 @@ *
  • This is point number 2
    • * *

    + * + * @MyTag.other this tag is not inline and will not appear in the description text. */ @CommandLineProgramProperties( summary = "Test tool summary",