首页
社区
课程
招聘
[推荐]Doxygen source and binary releases v1.5.5
发表于: 2008-2-28 01:43 3751

[推荐]Doxygen source and binary releases v1.5.5

2008-2-28 01:43
3751
Source code documentation generator toolDoxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP, C#, and to some extend D. It can help you in three ways:
  • It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in ) from a set of documented source files. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code.[*]You can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. You can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically.[*]You can even `abuse' doxygen for creating normal documentation (as I did for this manual).
Doxygen is developed under Linux and Mac OS X, but is set-up to be highly portable. As a result, it runs on most other Unix flavors as well. Furthermore, executables for Windows are available.
Doxygen licenseCopyright © 1997-2008 by [email=dimitri@stack.nl]Dimitri van Heesch[/email]. Permission to use, copy, modify, and distribute this software and its documentation under the terms of the GNU General Public License is hereby granted. No representations are made about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. See the GNU General Public License for more details. Documents produced by doxygen are derivative works derived from the input used in their production; they are not affected by this license. User examplesDoxygen supports a number of output formats where HTML is the most popular one. I've gathered some nice examples of real-life projects using doxygen. These are part of a larger list of projects that use doxygen. If you know other projects, let me know and I'll add them. Future workAlthough doxygen is used successfully by a lot of people already, there is always room for improvement. Therefore, I have compiled a todo/wish list of possible and/or requested enhancements. AcknowledgementsThanks go to: ●
  • Malte Zöckler and Roland Wunderling, authors of DOC++. The first version of doxygen borrowed some code of an old version of DOC++. Although I have rewritten practically all code since then, DOC++ has still given me a good start in writing doxygen.[*]All people at Troll Tech, for creating a beautiful GUI Toolkit (which is very useful as a Windows/Unix platform abstraction layer :-)[*]Kevin McBride for maintaining the subversion reporsitory for doxygen.[*]My brother Frank for rendering the logos.[*]Harm van der Heijden for adding HTML help support.[*]Wouter Slegers of Your Creative Solutions for registering the www.doxygen.org domain.[*]Parker Waechter for adding the RTF output generator.[*]Joerg Baumann, for adding conditional documentation blocks, PDF links, and the configuration generator.[*]Matthias Andree for providing a .spec script for building rpms from the sources.[*]Tim Mensch for adding the todo command.[*]Christian Hammond for redesigning the web-site.[*]Ken Wong for providing the HTML tree view code.[*]Talin for adding support for C# style comments with XML markup.[*]Petr Prikryl for coordinating the internationalisation support. All language maintainers for providing translations into many languages.[*]The band Porcupine Tree for providing hours of great music to listen to while coding.[*]many, many others for suggestions, patches and bug reports.
  • Farm::http://www.stack.nl/~dimitri/doxygen/index.html

    DownLoad:: ->
    ###############Doxygen source and binary releasesLatest releaseThe latest version of doxygen is 1.5.5 (release date 10 February 2008).
    The source distribution
    doxygen-1.5.5.src.tar.gz (3.8M) ( ftp | http )
    A binary distribution for Linux i386
    doxygen-1.5.5.linux.bin.tar.gz (2.5M) ( ftp | http )
    Compiled using Fedora Core 6 with kernel 2.6.19 and gcc-4.1.2. This archive includes the HTML version of the manual, but not the GUI frontend.
    A binary distribution for Windows 95/98/ME/NT/2000/XP/Vista
    doxygen-1.5.5-setup.exe (6.5M) ( ftp | http )
    This is a self-installing archive including the HTML and compressed HTML versions of the manual and the GUI frontend. If you are allergic to installers and GUIs or haven't sufficient bandwidth you can also download the binaries in a zip (2.2M) ( ftp | http )

    A universal binary distribution for Mac OS X
    Doxygen-1.5.5.dmg (17.6M) ( ftp | http )
    This is a self-contained disk image, which contains the GUI frontend and dot. All binaries are universal.
    See the change log to find out what has changed. If you want to be informed about new releases fill in your email address in the form at the top of this page. The documentation for release 1.5.5A hyperlinked PDF version of the documentation doxygen_manual-1.5.5.pdf.zip (0.6M)
    A compiled HTML version of the documentation doxygen_manual-1.5.5.chm.zip (0.8M)

    [注意]传递专业知识、拓宽行业人脉——看雪讲师团队等你加入!

    收藏
    免费 0
    支持
    分享
    最新回复 (1)
    雪    币: 234
    活跃值: (10)
    能力值: ( LV3,RANK:30 )
    在线值:
    发帖
    回帖
    粉丝
    2
    Doxygen 的使用简介
      Doxygen 是一个类似 JavaDoc 的文档生成工具。有了它,C++爱好者就可以为自己的源代码很方便地生成美观实用的文档了。

    为代码生成文档标注基础

      您可以使用JavaDoc风格,类似于由C风格的注释块:
    /**
    * ... 文本 ...
    */
    


    此外您也可以使用Qt风格,如
    /*!
    * ... 文本...
    */
    


    以上两种风格中间的*是可选的,也就是下面这样写也是可以的:
    /*!
    ... 文本...
    */
    


    第三种是使用至少两行C++"//"注释,如:
    ///
    /// ... 文本...
    ///
    


    或者
    //!
    //!...文本...
    //!
    


    有的程序员也许喜欢下面这种风格,有比较好的视觉效果:
    /////////////////////////////////////////////////
    /// ... 文本...
    /////////////////////////////////////////////////
    


      对于简单的描述信息,可能有几种情况。一种是在注释块的开头使用\brief命令,该命令一直到段落结束有效,所以详细描述信息从空一行后开始,如下例:
    /*! \brief 简洁的描述信息 description.
    * 又一些简洁的描述信息。
    *
    * 详细描述信息从这里开始。
    */
    


      在配置文件中,如果JAVADOC_AUTOBRIEF设为YES,则Doxygen将使用JavaDoc风格的注释块,从简洁描述信息后的点空格. 开始为详细描述信息,例如:

    /** 简洁信息结尾是一个点号. 详细描述信息从
    * 这里开始
    */
    


    该选项对C++风格的多行注释也是有效的:
    ///简洁信息结尾是一个点号. 详细描述信息从
    ///这里开始
    


    或者:
    /// 简洁描述信息
    /** 详细描述信息*/
    


    或者:
    //!简洁描述信息
    
    //!详细描述信息从
    //!这里开始
    


      此例中间空行用来分割简洁描述信息块和详细描述信息块。可见doxygen的文档标注使用格式是非常自由的。不过要注意下面格式是不合法的,因为doxygen只允许一块详细描述信息对应一块简洁描述信息:
    //!简洁描述信息
    //! 详细描述信息
    /*! 注意,又一详细描述信息!
    */
    


    下例使用Qt风格的文档标注:
    //! A test class. 
    /*!
    A more elaborate class description.
    */
    
    class Test
    {
      public:
    
        //! An enum.
        /*! More detailed enum description. */
        enum TEnum { 
                     TVal1, /*!< Enum value TVal1. */  
                     TVal2, /*!< Enum value TVal2. */  
                     TVal3  /*!< Enum value TVal3. */  
                   } 
             //! Enum pointer.
             /*! Details. */
             *enumPtr, 
             //! Enum variable.
             /*! Details. */
             enumVar;  
        
        //! A constructor.
        /*!
          A more elaborate description of the constructor.
        */
        Test();
    
        //! A destructor.
        /*!
          A more elaborate description of the destructor.
        */
       ~Test();
        
        //! A normal member taking two arguments and returning an integer value.
        /*!
          \param a an integer argument.
          \param s a constant character pointer.
          \return The test results
          \sa Test(), ~Test(), testMeToo() and publicVar()
        */
        int testMe(int a,const char *s);
           
        //! A pure virtual member.
        /*!
          \sa testMe()
          \param c1 the first argument.
          \param c2 the second argument.
        */
        virtual void testMeToo(char c1,char c2) = 0;
       
        //! A public variable.
        /*!
          Details.
        */
        int publicVar;
           
        //! A function variable.
        /*!
          Details.
        */
        int (*handler)(int a,int b);
    };
    


      Doxygen的文档标注是不是非常容易?当然还可以有更高级的应用,如标注列表、分组,甚至支持生成公式(Latex)。上面只编译了最简单的一些使用方法,更多内容请参考Doxygen的帮助文档doxygen_manual。

    附带文档的说明:

      DoxygWizard是基于QT的简易图形用户界面,简化了Doxygen的使用。您可以在DoxygWizard里对需要生成的文档进行设置,可保存为"Doxyfile",然后调用Doxygen生成文档。需要注意的是,文件路径不支持中文,所以尽可能使您的源代码和文档目录均为英文名。在"Doxyfile"文件同一目录请放置一个"mylogo"纯文本文件,内容可以是一些版权标识信息,这些信息将显示在生成文档页面的最下边,如果没有此"mylogo"文件,将生成默认的版权标识信息。
      样式表文件Orignl_doxygen.css、green_doxygen.css、yellow_doxygen.css、Blue_doxygen.css,改文件名为doxygen.css后,拷贝到生成html文档的目录内可以改变文档显示的样式。
      OUT PUT_LANGUAGE 可选项为Englisth(英文文档), Chinese(中文文档), En_Can_Cn(支持中文注释的英文文档)

    相关网址:
    http://www.doxygen.org/download.html
    您还需要下载graphviz dot画图:
    http://www.research.att.com/sw/tools/graphviz/
    2008-2-28 01:54
    0
    游客
    登录 | 注册 方可回帖
    返回
    //