代码之家  ›  专栏  ›  技术社区  ›  Chris Marshall

尝试将多个readme.md文件合并到doxygen转储中

  •  0
  • Chris Marshall  · 技术社区  · 8 年前

    我看不出上面的答案,所以我的问题是:

    我有一套计划。它们表示为嵌套的git子模块,如下所示:

    MAIN-PROJECT
        LIBRARY-1
            LIBRARY-2
                ETC.
    

    每个子模块都有一个readme.md文件和changelog.md文件(标准github模型):

    MAIN-PROJECT
        README.md
        CHANGELOG.md
        LIBRARY-1
            README.md
            CHANGELOG.md
            LIBRARY-2
                README.md
                CHANGELOG.md
                ETC.
    

    我想做的是使用“根”自述文件作为转储中的主页面,但仍然呈现内部自述文件,因为每个自述文件都有很好的信息。

    我不想单独构建每个doxygen转储。我希望有一个从“根”开始的单块转储,这是因为我希望类和其他东西链接起来。

    有办法吗?我试图显式地指定“根”自述文件,但看起来您只能给出文件名,而不能给出路径。这意味着每一个自述文件都会被考虑到,而获胜的是“最深”的一个。

    1 回复  |  直到 8 年前
        1
  •  1
  •   albert    8 年前

    要能够使用多个“readme.md”文件,需要考虑以下几点:

    • 使用时使用相对路径指定major readme.md USE_MDFILE_AS_MAINPAGE .
    • 交替使用 \mainpage 在“readme.md”中
    • 使用 \page 在另一个“readme.md”中,这样可以区分不同的文件。

    还要注意以下可能性 \subpage \ref 参考其他页

    推荐文章