Doxygen not documenting main function in main.cpp

前端 未结 4 1094
长发绾君心
长发绾君心 2020-12-31 02:49

I have a main.cpp that contains a struct, some global constants and a main function.

I ran doxygen and the only documentation I am getting in the output index.html i

4条回答
  •  太阳男子
    2020-12-31 03:36

    Make sure HIDE_IN_BODY_DOCS is set to NO and use something like this:

    /// \file
    
    /// \brief  Main function
    /// \param  argc An integer argument count of the command line arguments
    /// \param  argv An argument vector of the command line arguments
    /// \return an integer 0 upon exit success
    int main(int argc, char** argv)
    {
      /// Comments I would like to be documented in as well
      return 0;
    }
    

提交回复
热议问题