Relative Content

Tag Archive for documentation-generation

How to document experimental or incomplete APIs like @deprecated?

Is there a good term that is similar but different than “deprecate” to mean that a method or API is in the code base but should not be used because its implementation is not complete or will likely change? (Yeah, I know, those methods shouldn’t be public, yada yada yada. I didn’t create my situation, I’m just trying to make the best of it.)

Seeking advice on system documentation

I have a rating engine (it is basically an algorithm) which when I started had no formal documentation. We have created a functional specification/decomposition which is our business level document but now I need something more technical (a technical specification).

Should generated documentation go in version control history? [duplicate]

This question already has answers here: Should generated documentation be stored in a Git repository? (8 answers) Closed 5 years ago. I’m against compiled stuff going into version control, specially when it comes to compiled binaries, however, my principles are now in question after adding doxygen support for a project. Should the hundreds of files […]

Documentation Generation – FiM++

This is a question I originally asked on Stack Overflow, but as a conceptual design question as opposed to a technical issue, I believe it may be more appropriate, or possibly have alternate parallel value, on this board.

Does doxygen support templates for the HTML output?

I’ve documented my code for doxygen, but I don’t want the default HTML it gives. I know I can customize it by providing custom CSS, headers, footers, etc. (like GNOME does), and how I can add common PHP code to the files and tell it to save as .php, but that isn’t really what I want.

Functional document from code

I am a Sr java Developer and have recently joined a new team. Here I have been asked to create a functional document looking at the code of a legacy application. This application was written about 8-10 years back, which is currently running in live environment but due to lack of documentation it is difficult to be setup and run on local development box. I consulted some of the old team members who support it, but none was able to run it on their dev boxes.