doxygen

问题 Is there a way/tool to generate HTML documentation (similar to what doxygen does) directly from my Shell output or even a saved log ? If nothing is available, do you guys have any creative ideas on how to do that with the existing tools ? I'm thinking that while typing, I can put some sort of mark or special character and then have a tool pick that up as the beginning of a comment, while the rest of what is typed are CLI and output. Example : ubuntu@nso-172-73:~$ # This is a comment ubuntu

问题 Doxygen can generate class diagrams with graphiz. For example: class A {...}; class B extends A {...}; From this code I can generate a picture where doxygen can show that one class it the parent of an other. But is there a way to generate a picture from code with manual references between classes? For example when I describe DB scheme and use contract classes (http://developer.android.com/training/basics/data-storage/databases.html#DefineContract) I want to perform smth like this: class

问题 I'm documenting C code with doxygen. To make the documentation more readable I want to at least add code in every .c/.h file pair to one group using @defgroup and @ingroup. Inside these groups I want to group some defines together using @name blocks. The result in the "file" pages looks closely to what I expected: Everything that's documented in the file is listed there and more or less nicely grouped. In the "module" pages on the other hand only functions and variables are listed and the

问题 the Doxygen documentation says about \includedoc "This command works the same way as \include , but it will include the content of the file as if it were at the place where this command is called." So I set up EXAMPLE_PATH = includepages (Doxyfile) and created a file named test.dox in includepages sub folder. To ensure that usages is correct this is the content of test.dox : /*! * THIS IS A TEST */ THIS IS AN OTHER TEST Here is the way I do Include this page: * \include test.dox * *

问题 Closed. This question is off-topic. It is not currently accepting answers. Want to improve this question? Update the question so it's on-topic for Stack Overflow. Closed 2 years ago . I'm working on a C project that has seen many different authors and many different documentation styles. I'm a big fan of doxygen and other documentation generations tools, and I would like to migrate this project to use one of these systems. Is anybody aware of a tool that can scan source code comments for

问题 I currently have a couple of #define in c files that turn off some functionality to hardware for testing. However, I want to document them with doxygen when they are undefined as well. For example: This works fine: /// \def SIMULATE_SOME_HW_INTERFACE /// Define this when you want to simulate HW interface. #define SIMULATE_SOME_HW_INTERFACE When you change the #define to #undef, you get a warning in doxygen, and it doesn't show up in the doxygen generated output. I want to document this

问题 I know how to create a snippet by marking a section of an example file: //! [myfunc example] int i = myfunc(1,"example"); if (i = CORRECT_VALUE) printf("success"); //! [myfunc example] and then including that elsewhere with: /snippet mytestfile.c myfunc example In my case, my example files are my test files, and each example is actually already in a function, like this: void testMyFunc() { int i = myfunc(1,"example"); if (i = CORRECT_VALUE) printf("success"); } So what I want, is to be able

问题 I want Doxygen to document the code written in C-like language (PARI/GP) but having slightly different syntax. I believe Doxygen can document the entities those do not exist. It seems to be the simplest way to do the job while the programming language is not Doxygen-supported. I want something like this: /*! \fn foo(param,{option}) \brief some brief description here \param[in](param) mandatory parameter description \param[in](option) optional parameter description */ /*! \cond DOXYGEN_SHOULD

问题 I am currently using Doxygen 1.5.5 on Linux Some class documentation is unavailable in the Windows version of my documentation. My library provides several classes, one in uppercase and another in lowercase such as CONE and cone; thus, their class documentation is provided as classCONE.html and classcone.html. Due to case insensitivity for filenames on Windows systems, the uppercase class documentation overwrites lowercase class documentation when the ZIP file's contents are extracted onto a

问题 Say I have: #define MY_MACRO(FOO) void FOO(); MY_MACRO(hi); MY_MACRO(hey); MY_MACRO(hello); #undef MY_MACRO I want the macros to be expanded by doxygen, which I am able to do by configuring it the right way: ENABLE_PREPROCESSING = YES MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = YES EXPAND_AS_DEFINED = MY_MACRO This enables me to see the expanded result of the macros as documented APIs in the doxygen output (functions hi , hey , and hello ). That is all good so far. But the problem is that,