c++ - 使用 makefile 的 Doxygen 文档

Question

我用 c++ 编写了一个程序，我想使用 makefile 生成可执行文件。这行得通，但是我的代码中也有一些 Doxygen 风格的注释，我希望我的 makefile 自动生成带有文档的 HTML 页面。不幸的是，我无法弄清楚应该如何正确完成。到目前为止，我的 makefile 的文档部分如下所示:

docs:
    doxygen ./Doxyfile

我想我需要添加一些额外的文件，有人可以为我说明一下程序吗？

Answer 1

您可能希望添加依赖项，以便在源更改时生成文档。最简单的地方是在应用程序的构建规则中。当源更改并且需要构建应用程序时，您可以将其用作构建文档的触发器:

$(PROGRAM): $(OBJECTS)
    @echo Building $@
    $(CC) $(LDFLAGS) -o $@ $(OBJECTS) $(LIBS)
    @echo Updating Docs $@
    @doxygen

我想同样可以单独工作

DOCS=MyProject_html

docs: $(DOCS)/MyProject.html

$(DOCS)/MyProject.html: $(PROGRAM) $(OBJECTS)
    @echo Building Docs
    @doxygen

clean:
     rm -rf $(PROGRAM) $(OBJECTS) $(DOCS)

有一种更自动的生成方法，但这应该可行。