I am designing a class library designed to solve a wide scope of problems. One thing about this library is that it will be usable by several different languages and environments natively. For example, there will be a C++ version written entirely in C++, a .NET version written in C# and a Java version written in Java, without any dependen...
I want to compile the Xml documentation from a large project into some form that's easy to read and search, hopefully more convenient than browsing the raw source code. I'm not particularly worried about the end format - CHM, HTML, xyz - as long as it's usable. Being able to easily roll in (or link to) additional content would be a plus....
I haven't quite figured out a sensible workflow for building packages and writing their documentation. I want as much of the process (and the documentation) as possible to be automatically generated. The obvious way to do this seems to be to use package.skeleton to create the basic package files, then programmatically overwrite the DES...
What is the name of the tool that allowed VB.NET code to have embedded documentation comments (corresponding to C# documentation comments) that could be extracted by this tool? I am going through some old code; Visual Studio 2005 era. A trivial example is: 'Form overrides dispose to clean up the component list. ''' <summary> ''' Summ...
Anyone know if there is a way to importing .NET XML doc comment files into Doxygen project? I have a project that uses assemblies that that have XML comment files. I'd like Doygen to pick up that documentation and add it to my doc output. ...
At a new research job, I will be part of a long-term effort to clean up a pretty extensive Java codebase (7+ years of development). It currently resides on SVN, but I am considering Mercurial. There are perhaps two types of people collaborating on the project. Type 1: people who will be developing a lot of code and writing documentation...
I have a project that can be built via makefile, and I would like to add the ability for someone in the base directory to not only be able to build the executable via make, but also to build the documentation pdfs from LaTeX in a separate directory by typing make docs or something similar. I only need one pass to generate the documentati...
I have a module containing multiple global functions, and a global variable. The variable and some of the functions follow the 'private' naming convention for Python, with a leading underscore for the name. The other functions are intended to be public, and do not have a leading underscore. I have declared __all__, with a list of my pub...
I'm using NaturalDocs to generate code documentation for a Flash project that we're developing with Flash CS5 on a Mac running 10.6.4. Currently, I have an automator script I can click to trigger the UNIX script and generate the documentation, but I'd rather have it automatically generate the documentation whenever I compile. (This is ...
I'm programming with Apple's Bonjour SDK for Windows, that contains dns_sd.h. This file is full of documentation that seems to follow a fixed format. Some excerpts follow. This is apparently Emacs syntax: /* -*- Mode: C; tab-width: 4 -*- * * Copyright (c) 2003-2004, Apple Computer, Inc. All rights reserved. ... This appears near th...
Is there a customizable documentation generator for C#? As opposed to native xml documentation which provides documentations for classes, methods, properties, the documentation I am referring to here is more lower-level, ie it documents the flow of a method. for example in the given code void SomeMethod(){ ///doc:Do X SomeCodeToDoX /...
I'm a jack-of-all-trades-master-of-none programmer and as I jump around languages, quality consistent documentation is becoming more and more important to me. I've recently been using Doxygen, but Wikipedia reveals the usual ridiculous list of similar frameworks. What is your favorite documentation generator and why? (Vote where you agr...
Hi all, I'm having a problem with the javadoc generation in eclipse. In advance, thanks for taking the time. Here's what happens: I go to Project>Generate Javadoc..., select all of the files in the project, then press finish. Eclipse then goes and seemingly does its' thing. The output in the console looks more or less like this: Loadin...
Is there a tool to automatically add the @since tag to all elements when I want to have a release version? So let's say I have a bunch of methods and my base system is working now, so I decide to release it as version 0.1.0 What I want now is a tool that searches for every missing @since tag and adds it accordingly. I'm using Eclipse ...
In a C++ project I'm using doxygen and the javadoc style for documentation. I'm fairly new to javadoc and am not sure whether this type of thing is valid. /** * ...stuff... * @return foo foo foo foo foo. Foo foo * foo foo foo foo foo. */ i.e. the information for what is being returned (and my question applies to all tags) needs to...
Which documentation generator would people recommend for C# work? What are the pros and cons of each? Suggestions for a third option are also welcome :-) ...
In order to keep our software test procedures in line with our requirements documentation, I want to generate test procedures from smaller tests. Basically I want each statement in a lower level requirements document to be linked to a very atomic series of steps to test that requirement for pass/fail. Each of these short descriptions of...
I am trying to understand WebKit (2 Million lines of C++ code). I want a tool which takes a class name as input and tell me the names of all classes which inherit from it. For example, if I pass in "RenderObject" it should return RenderInline, RenderBox. I am using Fedora 13 and for debugging purpose I am using QtCreator IDE. ...
I have a HTM document generated in Java and I want to convert to MS Word document. If I try open the HTM document with MS Word, show me a pop-up with an advertisement and I don't want that. I want that the document show it directly. Thanks for your help! ...
I'm looking for a wiki like software where we can publish our public api documentation. I have found many people to use MediaWiki but this does not seem to be the most elegant way of doing it. I would love to have a place where we can easily define the APIs specs and have it in an easy to read format. I like how twitter did their api d...