These days a number of commercial and open source tools have been developed for this purpose. However(unfortunately), non of them meet my requirement for specific problem I am dealing with. Currently, I am working on a project that exposes a different classes and functions to user as scripting interface. the user can use the objects from...
Hi, I am working in a project where we are using a custom scripting language. I am looking for a documentation system such as Doxygen so that I could process the many script files that have been developped with this scripting languages. My basic needs are: to generate automatic documentation, to extract the calls graphs and establish ...
Okay, I'm fed up with phpDocumentator. It consumes way much more memory (1.4 GB) and time (5 minutes on 2.6GHz Core 2 Duo) than I'm willing to give it. Does there exist some really compatible program to generate documentation for PHP code? I've tried PHPDoctor, which looks nice, but it has some missing features. However it is probably c...
Assume I have a directory structure like this ~j/p1/src/ /Doxyfile1 /ss1/ /f1.c /f2.c ~j/p2/src/ /Doxyfile1 /ss1/ /f1.c /f2.c The contents of ~j/p1 and the contents of ~j/p2 were created as workspaces for the same part of a single Subversion repos...
Hi, I tried using Apple's shell script to automate doc set creation with every build (and loading that in XCode) - http://developer.apple.com/tools/creatingdocsetswithdoxygen.html but found that it had some bugs. Firstly it's not updating the entries in doxygen.config, perhaps one needs to put the settings in the exact hierarchy as it a...
I've got some C code from a 3rd party vendor (for an embedded platform) that uses global variables (for speed & space optimizations). I'm documenting the code, converting to Doxygen format. How do I put a note in the function documentation that the function requires on global variables and functions? Doxygen has special commands for...
I've got a project that I'm using Doxygen to generate documentation to. The documentation of the classes is fine, but I've also got some functions that I use in main() to create objects etc. I'd also like to have these into my documentation, but I have not figured how to do that. Any suggestions? ...
Hi everyone, I've used this tuto (http://www.duckrowing.com/2010/03/18/documenting-objective-c-with-doxygen-part-ii/) to create my documentation... I would like to run doxygen in some directories and not in others! The problem is that I don't want to reorganize all the directories! Is it possible to put a file in the directories I don't...
The Javadoc @see allows a simple string as an argument to refer to something like a book, e.g.: @see "The Java Programming Language." As far as I can tell, the Doxygen \see offers no equivalent. Is there any way to have a book reference generated in the documentation, e.g.: See Also The C++ Programming Language, Bjarne Stroust...
Hi, i am supposed to document my code with doxygen for a homework assignment, but i have problems getting doxygen to run. I have a Doxyfile provided, and have just installed doxygen on my machine. When i enter the command to run doxygen, "doxygen Doxyfile" I get the following error: failed to run html help compiler on index.hhp ...
I'm working on a project that uses multiple libraries, set up in a structure like so: /src /libs/libOne /libs/libTwo I want to generate a single Doxygen page which covers all my code as well as the libraries. This was quite simple by just pointing Doxygen at the root. However, I want the doxygen output to be grouped so I can clearly se...
I want to remove lines look as follows but I still want to return source code browsing Definition at line 377 of file xxx.h. I have tried the following two in the doxygen config file but these just remove cross references on types # If the REFERENCES_RELATION tag is set to YES # then for each documented function all documented enti...
I'm working on a fairly large project written in C. The idea was to build a library of modular blocks that can be reused across several platforms. Each module is associated with a word document in .docx format (huge pain to diff-merge). In these docs, an interface section is specified, listing datatypes and publicly accessible functions....
I use Doxygen's triple-slash syntax to markup my C++ code. There are two important cases which arise: 1) block markup comments which are the sole element on the line and may or may not begin flush left; e.g. class foo /// A one sentence brief description of foo. The elaboration can /// continue on for many lines. { ... }; voi...
hello. Is there some way to document template parameters like this: template< int N, ///< description typename T ///< description > rather than listing each parameter with tparam? please note that function arguments can be documented like this in current doxygen: void function(int a /**< description */); if there is not o...
I have been successful with this in the past but now I can't seem to find the setting that tells XCode or Doxygen (or both) to display compile errors if documentation is missing. I have looked at the Apple documentation that tells how to create docsets and that works fine but XCode does not throw compiling errors on missing comments in ...
Hello. I've never written documentation for any C-style code before (only done asdoc and phpdoc). I've been looking at Doxygen for documenting my Objective-C code, but I'm unsure where to put the comments. Should I document the .h files or should I add the comments to the .m files? or both? Any other recommendations? ...
I am trying to use Doxygen Automatic link generation to document some enum types. However, it is not generating links for the global enum types. It does generates links for the global struct types. Is there something I am missing? I am using the example provided on the link above. As required, I have documented the file in which the typ...
I'm having this issue where doxygen is adding the method twice in the documentation file. Is there a setting that stops auto-generation of documentation for methods within the .m file. For example in the documentation I'll see something like whats below where the first definition of + (Status *)registerUser is from the header XXXXXX.h...
I would like to add custom (non-project) files to generate some extra pages with Doxygen. I am (was actually) unsure how these files should be named and how their content should be formatted. ...