Geek asks and answers

Doxygen and License / Copyright Information

I have a simple question that I could not find while digging up Google.

I am transferring project documentation from phpDoc to Doxygen , but I don't know how to write @license and @copyright together.

In my concept, @copyright is for my "company" (but not real: P) and @license is the development method that I am developing: one of the many combinations of CreativeCommons, GNU, MIT, BSD, "licensed" ...

+6
source share
2 answers

Based on Chrisโ€™s response, you can use the command \parto create a block similar to a built-in command \copyright. For example, an alias like:

ALIASES += "license=@par License:\n"

:

/** My main function.

    \copyright Copyright 2012 Chris Enterprises. All rights reserved.
    \license This project is released under the GNU Public License.
*/
int main(void){
    return 0;
}

:

enter image description here

, \license {} . , , HTML.

+8

, , doxygen . , \author \copyright .

( ) , :

  1. \copyright:

    /** My main function.

    \copyright Copyright 2012 Chris Enterprises. All rights reserved.
    This project is released under the GNU Public License.
*/
int main(void){
    return 0;
}

    HTML

    Screenshot of the documentation generated by doxygen using first solution

    , .

  2. , HTML, ,

    <dl class="section copyright"><dt>Copyright</dt><dd>Copyright 2012 Chris Enterprises. All rights reserved. This project is released under the GNU Public License. </dd></dl>

    , , , license, copyright. ALIASES ALIASES doxygen

    ALIASES += license{1}="<dl class=\"section copyright\"><dt>License</dt><dd>\1 </dd></dl>"


    /** My main function.

    \copyright Copyright 2012 Chris Enterprises. All rights reserved.

    \license{This project is released under the GNU Public License.}
*/

    Screenshot of the documentation generated by doxygen using second solution

    , : \license{...} , \license . \copyright, , ALIASES .

+2

More articles:


All Articles