Minor bug on formatting Javadoc style comments

Please use this forum to signal bugs.
Merci d'utiliser ce forum pour signaler des bugs.

Minor bug on formatting Javadoc style comments

Postby morini » Sat 22 Aug 2015 10:07

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.
--
Thomas Schmidt
Velgen 1, D-29582 Hanstedt
PGP: Key-ID: 0x810B6206
morini
 
Posts: 12
Joined: Tue 9 Oct 2012 10:05
Location: Germany

Re: Minor bug on formatting Javadoc style comments

Postby Bruno Pagès » Sat 22 Aug 2015 20:50

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 2836 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 2836 times


anyway I think the best is to place "template"<class T>" after "${comment}", like that :
3.png
3.png (37.31 KiB) Viewed 2836 times
ImageAuthor of Bouml
Bruno Pagès
 
Posts: 449
Joined: Mon 20 Feb 2012 08:23
Location: France

Re: Minor bug on formatting Javadoc style comments

Postby morini » Sat 22 Aug 2015 22:42

That's it!
Thank you.
--
Thomas Schmidt
Velgen 1, D-29582 Hanstedt
PGP: Key-ID: 0x810B6206
morini
 
Posts: 12
Joined: Tue 9 Oct 2012 10:05
Location: Germany


Return to Bug reports / Rapports de bugs

Who is online

Users browsing this forum: No registered users and 1 guest

cron