If you've used javadoc and then come to doxygen, you may know what I mean when I say I miss the hierarchical (frame-based) view that made jumping from class to class and method to method easy. (For those who haven't seen it, imagine a tree-navigator in an IDE or over a filesystem). Has anyone come across something more like that to vi...
I'm interested to know if it is possible to have some comments in a function (c, c++, java) in a way that doxygen could put them in the generated html file. for example: function(...) { do_1(); /** * Call do_2 function for doing specific stuff. */ do_2(); } ...
How do I produce Qt-style documentation (Trolltech's C++ Qt or Riverbank's PyQt docs) with Doxygen? I am documenting Python, and I would like to be able to improve the default function brief that it produces. In particular, I would like to be able to see the return type (which can be user specified) and the parameters in the function br...
I have a small C++ project (~60 classes) that I need a human readable PDF of. I tried using doxygen but the LaTeX code it generates does not compile because it's too deeply nested for the LaTeX compiler. Before I start creating a PDF or HTML document myself using the XML sources doxygen generates, I wanted to know if anyone of you know...
Does anyone know of or have a Lingo filter for Doxygen? I have played with DocMaker, but it introduces dependencies on director and is not a flexible or full featured as Doxygen. -Marty ...
I'm working on a fairly big open source RTS game engine (Spring). I recently added a bunch of new C++ functions callable by Lua, and am wondering how to best document them, and at the same time also stimulate people to write/update documentation for a lot of existing Lua call-outs. So I figured it may be nice if I could write the docume...
In relation to this question, I was wondering if anyone knows a javascript code snippet/library to convert a single doxygen comment to HTML? For example, /** This is a comment block * * \b bold text * \i italic text */ would be converted to something like: <p>This is a comment block</p> <p><b>bold</b> text</p> <p><i>italic</i> t...
Doxygen unable to document for functions in .cpp like Hello All, I have a .cpp file and found that doxygen is unable to document function which contains the following format: //! //! \brief Test //! and perform operations on those points. //! void CTest::TestTri() EH_Start("CTest::TestTri") { } EH_Stop The EH_Start and EH_Stop a...
Background: I'm creating a hierarchy of composite dictionary data structures in Objective-C, and am inheriting from NSMutableDictionary so these classes can be used everywhere an NSDictionary/NSMutableDictionary is called for. (Just so people don't think I'm reinventing the wheel, each one uses a CFMutableDictionaryRef, plus some additi...
I'm working with Doxygen at the workplace and am having a problem with the Java code. With the EXTRACT_ALL=NO, EXTRACT_PRIVATE=NO, EXTRACT_STATIC=NO, EXTRACT_LOCAL_CLASSES=NO, and EXTRACT_LOCAL_METHODS=NO, the output still includes static members that are not defined as public or private. EX. Let's say I have the following code: class ...
I'm working on a project where a c++/cli library is being used primarily from a c# application. Is there any way to make the code comments in c++/cli visible to c# intellisence within visual studio? Assuming there isn't, what would be the best way to document the c++/cli code to enable its easier use from c# (and within c++/cli of cour...
I'm evaluating the AtomineerUtils addin (which allows Visual Studio to auto-enter doxygen comment blocks). It misfires slightly when I have a class definition that has __declspec (dllexport) in it. That is, instead of the class name appearing in the comment block it adds, it uses the word declspec. Small annoyance, but annoyance nonet...
I'm trying to use xrefitem to create a "Related Page", but it doesn't seem to be working, nor inline. Here is an example: /// \xrefitem makeup "Makeup" "This is made up" ok so it is /// \xrefitem makeup2 "Makeup2" "This is made up2" Ok it #ismade"up" I'm using Doxygen 1.5.9. Neither of these show up in the related pages. I'm also inc...
In doxygen, I can create objective-c categories inside my implementation file to hide interfaces that shouldn't be accessed publicly. However, doxygen still documents the category as the members being "public". Even by adding the \protected or \private, this is still the case. Is there another method that I'm overlooking that would put...
Question: Can I document Ruby code using Doxygen? Disclaimer: I know ruby already has a system for documentation built in and there are probably other ways to do it as well, but the specific constraint I am operating under is how to get Doxygen to do the job (assuming it is possible). Thanks in advance for any pointers. ...
I followed this guide from Apple to create doxygen documentation. I did need to modify the script to put variables in quotes so when it parses a directory with spaces, it doesn't treat it as two separate arguments. That said, I recently switched to use subversion in XCODE instead of using the Snapshot stuff, which has a notorious histor...
I'm trying to find automated way of finding where in the code a function is used. Some form of autogenerated documentation where I have Class->method is used in this files: a.php , b.php etc. I am tryng to find something out there to prevent rolling my own. We currently have no automated documentation system so anything goes. ...
Hello, I'm looking for a decent code documentation generator for C# that can create an html-format documentation straight from source. I don't want to use Sandcastle, because it's too tedious to use and I don't use VS for my work, though Sandcastle's output is exactly what I need. I also need the functionality of Doxygen - just save a...
Hi, I'm looking for a documentation generator for python. I'm familiar with javadoc, and I tried Doxygen, but it seems quite unfit and counter-intuitive for python. Any ideas? Udi EDIT Apart from the excellent answers below, you can also consult wikipedia's exhaustive Comparison of documentation generators. ...
The software group I currently work in has recently decided to start documenting our codebase. The initial approach they have been taking was to use the built in triple slash /// method of documenting. A newer issue we began to find was that the result of running this through doxygen is a very nice representation of the codebase but fo...