I am a big fan of Doxygen which I have used for years with various languages. In particular, I appreciate its wiki-like ability to include images and run the Graphviz dot generator to have arbitrary inline diagrams from inline DOT code or external files. RDoc has diagramming support to generate class diagrams using Graphviz but I can't ...
We have a very old application dating back to ASP era which we are gradually refactoring to ASP.NET + VB.NET codebase. It contains a lots of files with the below types: aspx, asmx, ascx, vb, js (JavaScript), html, vbs (VBScript). The backend database is SQL Server 2005 with lots of sprocs. We would like to create a code documentatio...
I am part of a large organization in the insurance industry. I am currently looking at the way we manage our internal product documentation and I want to get some feedback for the community. We currently author documents using Word, Excel, Publisher, and PowerPoint. If we want to create a "training manual" we simple copy and past this i...
My web app has rather large class library that is documented with XML comments which Sand Castle nicely puts together into a CHM file for me from the .dll's and .xml comment files that the VS compiler generates. The front-end piece of my app consists of hundreds of .aspx files which I can document with XML comments and with the /doc com...
Public c++ header files must be provided with a lot of comments. It is hard to format and wrap doxygen comments. Does some formatting tool exists? With features like auto wrap lines on 80th character, easy visual function grouping. Ideally documentation writer prepares a documentation separately, then inject it into or link using doxyta...
I have a Visual Studio (C#) project in which the "XML documentation file" property is enabled. It also has "Treat warnings as errors" set to All. There is one particular class which has no XML comments and they will not be added to it. Since XML documentation and warnings as errors are enabled, this causes builds to fail. Is there a ...
Hi, I have some JavaScript to document and am not sure which tool is best to use - ideally I would like to publish the docs online but also have an offline browsable version. I know there are more tools about than jsdoc nowadays - any experiences of different doc tools for JavaScript would be useful. If it has a maven plugin that would...
Hi, I'm going to be generating API docs using Sandcastle - I couldn't find any guides on how to do this on there website. Does anyone have any quickstart guides they would recommend? ...
I'm using Doxygen with some embedded C source. Given a .c/.h file pair, do you put Doxygen comments on the function prototype (.h file) or the function definition (.c file), or do you duplicate them in both places? I'm having a problem in which Doxygen is warning about missing comments when I document in one place but not the other; is ...
Who else makes tools like Scitools Understand C++ and which is better? Looking for the most complete auto documentation tools for Ada, C, C++ and Fortran. For analysis of tool migration effort, to aid to in pruning dead code and identifying essential functionality. Pete ...
Hi, I'm using Sandcastle Help File Builder GUI and I can't seem to get code examples in my comments to appear in the help file output. I'm generating Help 1.x and MSDN-style HTML documentation. The examples look like the following in my code: /// <summary> /// Connects to the server /// </summary> /// <example> Connec...
What OSS (or free) tools are available for drafting a single source for documentation that can be used to generate manuals? Specifically, in the following formats: HTML website PDF document Embedded (within an application; possibly HTML)1 Text (optional) Man pages (optional) Additional requirements: Tool is suitable for technical w...
I have an FAQ in HTML (example) in which the questions refer to each other a lot. That means whenever we insert/delete/rearrange the questions, the numbering changes. LaTeX solves this very elegantly with \label and \ref -- you give items simple tags and LaTeX worries about converting to numbers in the final document. How do people de...
Hello, I'd like to create a simple central documentation that visually shows various processes and dependencies in my ASP.NET MVC application, for example how a service is called when my "Signup" action method gets POST data, decryption and verification happens, and finally everything is stored using the repository and the email service...
I'd love to ask you how do the guys developing dojo create the documentation? From nightly builds you can get the uncompressed js files with all the comments, and I'm sure there is some kind documenting script that will generate some html or xml out of it. I guess they use jsdoc as this can be found in their utils folder, but I have n...
Hi, I work for a insurance company. We have our own development department made-up of almost 150 people plus some providers (outsourcing and custom made apps pretty much). In our company my team have made what we call non-fucntional logic libraries. That is, software libraries to handle things that are horizontal to all the development...
Hi, I have installed Sphinx in order to document some python modules and class I'm working on. While the markup language looks very nice, I haven't managed to auto-document a python code. Basically, I have the following python module: SegLib.py And A class called Seg in it. I would like to display the docstrings of the class and mod...
Hi, This is a generalized version of a previous question regarding Sphinx. Is there a way to recursively autodocument modules or packages which contain classes and functions within them? I think it is silly to add the autofunction or automodule directive for each function; There must be a way to automate the process, otherwise I don't...
I am attempting to more fully document our database packages as an API. What we would like is something like JavaDocs for PL/SQL. I have seen a couple tools out there (pldoc, plsqldoc) but would like to know from people who use them how they compare. ...
Let's say I have a PHP class called Color, it's constructor accepts various params. // hex color $myColor = new Color('#FF008C'); // rgb channels $myColor = new Color(253,15,82); // array of rgb channels $myColor = new Color(array(253,15,82)); // X11 color name $myColor = new Color('lightGreen'); My question is: How should I use p...