Welcome to the Linux Foundation Forum!

Doxygen

Options

Hi,

I have having some problem with Doxygen. I want to create the HTML website with digram. I have three files ( two .c files and a header file)

I have configured the Doxyfile from the following website http://www.ibm.com/developerworks/aix/library/au-learningdoxygen/

It create the html website but no diagrams. Then i install the graphviz on my fedora and again run the Doxyfile but again no images.

I am not sure what is worng, OR is the method i am following is all wrong.

Thank you in advance.

Usman

Comments

  • usmangt
    Options
    Ok it worked now after following the exact settings from the following link http://www-scf.usc.edu/~peterchd/doxygen/

    I am also making the LaTex file, and the doxygen generate a latex folder including a makefile to compile all files together in a one piece but it's looks that the PDF file generated by it is broken.

    Any idea about this.

    Thank you :)

    usmangt
  • raul2007
    raul2007 Posts: 2
    edited December 2016
    Options

    Hi,

    If you are on Linux OS, and you want to run Doxygen, you can run it from command line.

    /**

    *

    * ------------------- For Linux User-----------------------------

    *  => Doxygen Installation steps.    

    *  => User guide.    

    */

    # Required Packages.

    1> sudo apt-get install gcc

    2> sudo apt-get install g++

    3> sudo apt-get install cmake

    4> sudo apt-get install flex

    5> sudo apt-get install bison

    6> cd <complete path of project directory>

    7> mkdir doc

    # For DoxyWizard Gui.

    8> sudo apt-get install doxygen-gui

    9> doxywizard

    10> fill required info. in doxygen gui

        a>  step 1. select path of project.

                destination directory: <project directory/doc>

                NEXT

        b> step 2.  NEXT

        c> UNMARK LaTeX -> NEXT

        d> Save (contr+s) -> save as Doxyfile -> OK

        d> Dont CLOSE doxygen gui window.

              

    11> After completing programs with comment.

       Note: All comment should be in following formate.

        /**

         * comment

        */



    12> doxygen ./Doxyfile

    13> Doxygen create documentation for you in <project directory/doc/>

    14> In <project directory/doc/> search index.html

    15> Open index.html

    Best Luck.

    Thank You :)

Categories

Upcoming Training