Author Topic: enable JAVADOC_AUTOBRIEF in doxygen style document generation option  (Read 4679 times)

Offline ollydbg

  • Developer
  • Lives here!
  • *****
  • Posts: 5970
  • OpenCV and Robotics
    • Chinese OpenCV forum moderator
Hi, alpha, I see that we have many doxygen style document in our C::B source, which only have one line before the function
Such as in include\projectfile.h (also there are many in CodeCompletion document).
Code
...
        /** The weight. This is a number between 0 and 100 (defaults to 50).
          * Files with smaller weights are compiled earlier than those with larger weights. */
        unsigned short int weight;

        /** If true, the file is open inside an editor. */
        bool editorOpen; // layout info

        /** Split type of the editor as int. */
        int editorSplit; // layout info

        /** Last active splitview (1 or 2). */
        int editorSplitActive; // layout info

        /** Last splitter position. */
        int editorSplitPos; // layout info

        /** The last known caret position in an editor for this file (left/top control if split). */
        int editorPos; // layout info

        /** The last known caret line in an editor for this file (left/top control if split). */
        int editorTopLine; // layout info
...

So, when generate the http://alpha0010.github.io, I strongly suggest enable this option, so that the first line is used as the brief of the function document.
« Last Edit: June 27, 2015, 03:36:04 pm by ollydbg »
If some piece of memory should be reused, turn them to variables (or const variables).
If some piece of operations should be reused, turn them to functions.
If they happened together, then turn them to classes.

Offline Alpha

  • Developer
  • Lives here!
  • *****
  • Posts: 1513
Re: enable JAVADOC_AUTOBRIEF in doxygen style document generation option
« Reply #1 on: June 27, 2015, 05:11:29 pm »
Testing it out.  Unfortunately enabling this exposes a doxygen bug where it generates invalid xhtml.  I will see if I can easily patch doxygen... if not, I will change file extensions to html (sorry IE users, no graphs for you), though I would like to avoid breaking links like that.

Offline Alpha

  • Developer
  • Lives here!
  • *****
  • Posts: 1513
Re: enable JAVADOC_AUTOBRIEF in doxygen style document generation option
« Reply #2 on: June 27, 2015, 10:08:07 pm »
Done; links broken.  (If trying to find a page, delete the file extension, and it should work.)

Offline oBFusCATed

  • Developer
  • Lives here!
  • *****
  • Posts: 13413
    • Travis build status
Re: enable JAVADOC_AUTOBRIEF in doxygen style document generation option
« Reply #3 on: June 27, 2015, 11:09:47 pm »
I don't know if it is only on my computer, but this link http://alpha0010.github.io/ doesn't work.
It shows the page not found message.
(most of the time I ignore long posts)
[strangers don't send me private messages, I'll ignore them; post a topic in the forum, but first read the rules!]

Offline Alpha

  • Developer
  • Lives here!
  • *****
  • Posts: 1513

Offline ollydbg

  • Developer
  • Lives here!
  • *****
  • Posts: 5970
  • OpenCV and Robotics
    • Chinese OpenCV forum moderator
Re: enable JAVADOC_AUTOBRIEF in doxygen style document generation option
« Reply #5 on: June 28, 2015, 01:09:34 am »
Done; links broken.  (If trying to find a page, delete the file extension, and it should work.)
Thanks!
If some piece of memory should be reused, turn them to variables (or const variables).
If some piece of operations should be reused, turn them to functions.
If they happened together, then turn them to classes.