I'm trying to make the comment for my getters look like this:
/**
* Gets the {@link #${e.g(1).fl()}}.
*/
Eg, for int getFoo(), I'd get:
/** * Gets the {@link #foo}. */
But for some reason that I can't figure out (and is driving me crazy), the actual comment that JAutodoc generates is:
/** * Gets the {@link #foo}. * * @return the foo */
I can't figure out where the extra text is coming from! At first I thought perhaps that the templates "stack", so I deleted all the other templates, but it's still appearing.
I also have issues with the setters inserting a new line in the document. My setters are using:
/**
* Sets the {@link #${e.g(1).fl()}}.
* @param ${e.g(2)} The new value.
*/
But they end up looking like:
/** * Sets the {@link #foo}. * * @param foo The new value. */
And I don't know why that new line is being inserted.
Are templates not inserted verbatim?
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
The Javadoc comment is incomplete without the @return tag and JAutodoc always completes a comment, independent from the template. So your desired result is not possible with JAutodoc.
The templates are getting parsed (looking for missing tags), then completed and the output is re-formatted. When you select the option "Use Eclipse comment formatter", you can configure the output under "Preferences->Java->Code Style->Formatter". Tab: Comments.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
I'm trying to make the comment for my getters look like this:
/** * Gets the {@link #${e.g(1).fl()}}. */Eg, for
int getFoo(), I'd get:But for some reason that I can't figure out (and is driving me crazy), the actual comment that JAutodoc generates is:
I can't figure out where the extra text is coming from! At first I thought perhaps that the templates "stack", so I deleted all the other templates, but it's still appearing.
I also have issues with the setters inserting a new line in the document. My setters are using:
/** * Sets the {@link #${e.g(1).fl()}}. * @param ${e.g(2)} The new value. */But they end up looking like:
And I don't know why that new line is being inserted.
Are templates not inserted verbatim?
The Javadoc comment is incomplete without the @return tag and JAutodoc always completes a comment, independent from the template. So your desired result is not possible with JAutodoc.
The templates are getting parsed (looking for missing tags), then completed and the output is re-formatted. When you select the option "Use Eclipse comment formatter", you can configure the output under "Preferences->Java->Code Style->Formatter". Tab: Comments.