[forge-issues] [JBoss JIRA] (ROASTER-98) MethodSource.getJavaDoc().getFullText() formats @param without space

George Gastaldi (JIRA) issues at jboss.org
Wed Mar 16 09:59:00 EDT 2016


     [ https://issues.jboss.org/browse/ROASTER-98?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

George Gastaldi updated ROASTER-98:
-----------------------------------
    Description: 

{noformat}
    public static void main(String[] args) {
        JavaClassSource src = Roaster.parse(JavaClassSource.class,
                "package issue;\npublic class Issue { \n" +
                        "   /**\n" +
                        "     * Creates a new instance of CLASS\n" +
                        "     *\n" +
                        "     * @param actual the actual value.\n" +
                        "     * @return the modified text\n" +
                        "     */\n" +
                        "    public static String someMethod(String actual) {\n" +
                        "        return actual;\n" +
                        "    }}");
        System.out.println(src); //looks ok
        MethodSource<JavaClassSource> method = src.getMethods().get(0);
        System.out.println(method);//looks ok

        System.out.println(method.getJavaDoc().getFullText());//looks not ok
        //will have "@paramactual  the actual value." instead of "@param actual the actual value."
    }
{noformat}

  was:


{noformat}
    public static void main(String[] args) {
        JavaClassSource src = Roaster.parse(JavaClassSource.class,
                "package issue;\npublic class Issue { \n" +
                        "   /**\n" +
                        "     * Creates a new instance of CLASS\n" +
                        "     *\n" +
                        "     * @param actual the actual value.\n" +
                        "     * @return the modified text\n" +
                        "     */\n" +
                        "    public static String someMethod(String actual) {\n" +
                        "        return actual;\n" +
                        "    }}");
        System.out.println(src); //looks ok
        MethodSource<JavaClassSource> method = src.getMethods().get(0);
        System.out.println(method);//looks ok

        System.out.println(method.getJavaDoc().getFullText());//looks not ok
        //will have "@paramactual  the actual value." instead of "@param actual the actual value."
    }
{noformat}

       Priority: Minor  (was: Critical)


I am sorry, but this is not a critical issue. This is a minor issue, as the method works but requires some minor tweaks

> MethodSource.getJavaDoc().getFullText() formats  @param without space 
> ----------------------------------------------------------------------
>
>                 Key: ROASTER-98
>                 URL: https://issues.jboss.org/browse/ROASTER-98
>             Project: Roaster
>          Issue Type: Bug
>          Components: API
>    Affects Versions: 2.18.3.Final
>            Reporter: Elis Edlund
>            Priority: Minor
>             Fix For: 2.x Future
>
>
> {noformat}
>     public static void main(String[] args) {
>         JavaClassSource src = Roaster.parse(JavaClassSource.class,
>                 "package issue;\npublic class Issue { \n" +
>                         "   /**\n" +
>                         "     * Creates a new instance of CLASS\n" +
>                         "     *\n" +
>                         "     * @param actual the actual value.\n" +
>                         "     * @return the modified text\n" +
>                         "     */\n" +
>                         "    public static String someMethod(String actual) {\n" +
>                         "        return actual;\n" +
>                         "    }}");
>         System.out.println(src); //looks ok
>         MethodSource<JavaClassSource> method = src.getMethods().get(0);
>         System.out.println(method);//looks ok
>         System.out.println(method.getJavaDoc().getFullText());//looks not ok
>         //will have "@paramactual  the actual value." instead of "@param actual the actual value."
>     }
> {noformat}



--
This message was sent by Atlassian JIRA
(v6.4.11#64026)


More information about the forge-issues mailing list