Page 1 of 1

Minor bug on formatting Javadoc style comments

PostPosted: Sat 22 Aug 2015 10:07
by morini
I switched to those nice Javadoc style comments. Indentation of the first comment line is to much.

Code: Select all
    template<class T>
            /**
     * Emits a `valueChanged´ Observation event for `attributeName´ with
     * `newValue´ of type `T'.
     */
    inline void valueChanged(const string & attributeName, const T & newValue);


This template declaration comes inside a class declaration body.

Re: Minor bug on formatting Javadoc style comments

PostPosted: Sat 22 Aug 2015 20:50
by Bruno Pagès
I think I understand, you added the form "template"<class T>" by hand in the declaration like that :
1.png
1.png (37.76 KiB) Viewed 2948 times
because the spaces aren't at the beginning of the form but after the template and before "${comment}" you have this result

You need to place the indent at the beginning, this means before the template, like that :
2.png
2.png (42.55 KiB) Viewed 2948 times


anyway I think the best is to place "template"<class T>" after "${comment}", like that :
3.png
3.png (37.31 KiB) Viewed 2948 times

Re: Minor bug on formatting Javadoc style comments

PostPosted: Sat 22 Aug 2015 22:42
by morini
That's it!
Thank you.