dongtu7205 2011-06-14 07:44
浏览 138
已采纳

如何在doxygen文档中包含文件夹?

I want to include folder in doxygen documentation.

I have tried \page and \include but it hasn't worked, does anyone know how to do it? Here is the tree :

+root
-+controllers
--- category.php
-+models
--- categories.php
- mainpage.php
  • 写回答

1条回答 默认 最新

  • ds0678 2011-07-23 15:14
    关注

    To add to the comments on your question, the \page command will add pages into your documentation that you have manually written. I.e. if a source file contains a \page declaration it will add the contents to the documentation index. You can add extra help here, such as:

    /*! \page overviewpage Architecture Overview
     *
     * \section memorymanagement Memory Management
     *
     * Some writing you want to appear as a help page in the documentation here.
     */
    

    The \include command will include a copy of a file as a source code block.

    I think you're actually asking how you get Doxygen to add multiple source directories. As long as the recursive setting is YES, which is not the default, it should work fine for your structure if you've set the root folder as the Doxygen input.

    RECURSIVE              = YES
    

    If you haven't, you can add different folders like this, with paths relative to the Doxyfile file.

    #---------------------------------------------------------------------------
    # configuration options related to the input files
    #---------------------------------------------------------------------------
    
    # The INPUT tag can be used to specify the files and/or directories that contain 
    # documented source files. You may enter file names like "myfile.cpp" or 
    # directories like "/usr/src/myproject". Separate the files or directories 
    # with spaces.
    
    INPUT                  = src test/src
    
    本回答被题主选为最佳回答 , 对您是否有帮助呢?
    评论

报告相同问题?

悬赏问题

  • ¥15 拟通过pc下指令到安卓系统,如果追求响应速度,尽可能无延迟,是不是用安卓模拟器会优于实体的安卓手机?如果是,可以快多少毫秒?
  • ¥20 神经网络Sequential name=sequential, built=False
  • ¥16 Qphython 用xlrd读取excel报错
  • ¥15 单片机学习顺序问题!!
  • ¥15 ikuai客户端多拨vpn,重启总是有个别重拨不上
  • ¥20 关于#anlogic#sdram#的问题,如何解决?(关键词-performance)
  • ¥15 相敏解调 matlab
  • ¥15 求lingo代码和思路
  • ¥15 公交车和无人机协同运输
  • ¥15 stm32代码移植没反应