[jira] Created: (QDOX-154) JavaMethod#getComment() is parsed with an implicit order

JavaMethod#getComment() is parsed with an implicit order
--------------------------------------------------------

                 Key: QDOX-154
                 URL: http://jira.codehaus.org/browse/QDOX-154
             Project: QDox
          Issue Type: Bug
            Reporter: Vincent Siveton




--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

---------------------------------------------------------------------
To unsubscribe from this list, please visit:

    http://xircles.codehaus.org/manage_email

     [ http://jira.codehaus.org/browse/QDOX-154?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Vincent Siveton updated QDOX-154:
---------------------------------

    Attachment: TestQDOX154.java

Here is a small sample:

{noformat}
    /**
     * A Javadoc sample.
     *
     * @return The size.
     */
    public long getSize()
    {
        return 0;
    }

    /**
     * @return The size.
     *
     * A Javadoc sample.
     */
    public long getSize2()
    {
        return 0;
    }
{noformat}

The javaMethod.getComment() is empty for getSize2() and should be equal to "A Javadoc sample."
If it is a known limitation, the API should reflect this limitation.

I attached a test case which displays the following.

{noformat}
Looking the class: test.TestQDOX154
Looking the method: getSize
javaMethod.getComment()=A Javadoc sample.
javaMethod.getTagByName( "return" )=The size.
Looking the method: getSize2
javaMethod.getComment()=
javaMethod.getTagByName( "return" )=The size.

A Javadoc sample.
{noformat}

> JavaMethod#getComment() is parsed with an implicit order
> --------------------------------------------------------
>
>                 Key: QDOX-154
>                 URL: http://jira.codehaus.org/browse/QDOX-154
>             Project: QDox
>          Issue Type: Bug
>            Reporter: Vincent Siveton
>         Attachments: TestQDOX154.java
>
>

--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

---------------------------------------------------------------------
To unsubscribe from this list, please visit:

    http://xircles.codehaus.org/manage_email

     [ http://jira.codehaus.org/browse/QDOX-154?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Robert Scholte resolved QDOX-154.
---------------------------------

         Assignee: Robert Scholte
       Resolution: Cannot Reproduce
    Fix Version/s: 1.10

test added, but succeeds right now. Good chance it's already solved by another issue (rev. 611)

> JavaMethod#getComment() is parsed with an implicit order
> --------------------------------------------------------
>
>                 Key: QDOX-154
>                 URL: http://jira.codehaus.org/browse/QDOX-154
>             Project: QDox
>          Issue Type: Bug
>            Reporter: Vincent Siveton
>            Assignee: Robert Scholte
>             Fix For: 1.10
>
>         Attachments: TestQDOX154.java
>
>

--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

---------------------------------------------------------------------
To unsubscribe from this list, please visit:

    http://xircles.codehaus.org/manage_email

     [ http://jira.codehaus.org/browse/QDOX-154?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Robert Scholte reopened QDOX-154:
---------------------------------


test was invalid, issue needs another review

> JavaMethod#getComment() is parsed with an implicit order
> --------------------------------------------------------
>
>                 Key: QDOX-154
>                 URL: http://jira.codehaus.org/browse/QDOX-154
>             Project: QDox
>          Issue Type: Bug
>            Reporter: Vincent Siveton
>            Assignee: Robert Scholte
>             Fix For: 1.10
>
>         Attachments: TestQDOX154.java
>
>

--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

---------------------------------------------------------------------
To unsubscribe from this list, please visit:

    http://xircles.codehaus.org/manage_email

    [ http://jira.codehaus.org/browse/QDOX-154?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=183254#action_183254 ]

Robert Scholte commented on QDOX-154:
-------------------------------------

I've been thinking: what to do if there's a description above AND below a tag? Only one place to find the answer:[http://java.sun.com/j2se/javadoc/writingdoccomments/#format]
According to this, the current behaviour is correct.
But some data will get lost this way. So I'm not yet sure what to do. An option could be  to add an extra method which will return the complete block unparsed.
But I don't really like this, so maybe we should consider this as a "won't resolve".

> JavaMethod#getComment() is parsed with an implicit order
> --------------------------------------------------------
>
>                 Key: QDOX-154
>                 URL: http://jira.codehaus.org/browse/QDOX-154
>             Project: QDox
>          Issue Type: Bug
>            Reporter: Vincent Siveton
>            Assignee: Robert Scholte
>             Fix For: 1.10
>
>         Attachments: TestQDOX154.java
>
>

--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

---------------------------------------------------------------------
To unsubscribe from this list, please visit:

    http://xircles.codehaus.org/manage_email

    [ http://jira.codehaus.org/browse/QDOX-154?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=183271#action_183271 ]

Vincent Siveton commented on QDOX-154:
--------------------------------------

Robert, according the doc, my understanding is the same than you: the behaviour is correct.
I propose that you add some documentation with this pointer and close this issue as you proposed.

For the record, here is the javadoc tool test:

{noformat}
    /**
     * @return The size.
     *
     * A Javadoc sample.
     */
    public long getSize2()
    {
        return 0;
    }
{noformat}

Here is the generated Javadoc by the Javadoc tool:
{noformat}
<a name="getSize2()"><!-- --></a><h3>
getSize2</h3>
<pre>public long <b>getSize2</b>()</pre>
<dl>
<dd><dl>
</dl>
</dd>

<dd><dl>

<dt><b>Returns:</b></dt><dd>The size.

 A Javadoc sample.</dd></dl>
</dd>
</dl>
{noformat}

> JavaMethod#getComment() is parsed with an implicit order
> --------------------------------------------------------
>
>                 Key: QDOX-154
>                 URL: http://jira.codehaus.org/browse/QDOX-154
>             Project: QDox
>          Issue Type: Bug
>            Reporter: Vincent Siveton
>            Assignee: Robert Scholte
>             Fix For: 1.10
>
>         Attachments: TestQDOX154.java
>
>

--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

---------------------------------------------------------------------
To unsubscribe from this list, please visit:

    http://xircles.codehaus.org/manage_email

     [ http://jira.codehaus.org/browse/QDOX-154?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Robert Scholte closed QDOX-154.
-------------------------------

    Resolution: Not A Bug

Closing issue because behaviour follows javadoc specs. I added the test with proper expecting values to prefend other behaviour in the future.

> JavaMethod#getComment() is parsed with an implicit order
> --------------------------------------------------------
>
>                 Key: QDOX-154
>                 URL: http://jira.codehaus.org/browse/QDOX-154
>             Project: QDox
>          Issue Type: Bug
>            Reporter: Vincent Siveton
>            Assignee: Robert Scholte
>             Fix For: 1.10
>
>         Attachments: TestQDOX154.java
>
>

--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

---------------------------------------------------------------------
To unsubscribe from this list, please visit:

    http://xircles.codehaus.org/manage_email