Documenting an existing website (symfony)

Posted by Mark Blades on Stack Overflow See other posts from Stack Overflow or by Mark Blades
Published on 2009-12-14T13:38:57Z Indexed on 2010/03/19 10:01 UTC
Read the original article Hit count: 211

Filed under:

documentation

|

doxygen

Hi,

I need to document a web application which wasn't built by me. It was built in symfony.

The documentation needed is code documentation, including list/description of classes, components etc and their interdependencies. At the moment the code isn’t commented much and the way it has been commented is inconsistent.

I was thinking of using Doxygen to generate initial documentation and then take it from there.

Any other suggestions?

Thanks in advance.

Mark.

© Stack Overflow or respective owner

Related posts about documentation

Hyperlinked, externalized source code documentation

as seen on Programmers - Search for 'Programmers'
Why do we still embed natural language descriptions of source code (i.e., the reason why a line of code was written) within the source code, rather than as a separate document? Given the expansive real-estate afforded to modern development environments (high-resolution monitors, dual-monitors, etc… >>> More
A tool to aid completion of missing or incomplete source code documentation

as seen on Stack Overflow - Search for 'Stack Overflow'
I have several finished, older PHP projects with a lot of includes that I would like to document in javadoc/phpDocumentor style. While working through each file manually and being forced to do a code review alongside the documenting would be the best thing, I am, simply out of time constraints,… >>> More
Quick C# Project Documentation in Visual Studio

as seen on Internet.com - Search for 'Internet.com'
Here's a quick way to document your .NET projects. >>> More
SQLAuthority News – Feature Pack for Microsoft SQL Server 2005 SP4

as seen on SQL Authority - Search for 'SQL Authority'
If you are still using SQL Server 2005 – I suggest that you consider migrating to later version of the SQL Server 2008/2008 R2. Due to any reason, you wanted to continue using SQL Server 2005, I suggest that you take a look at the Feature Pack for Microsoft SQL Server 2005 SP4. There are many… >>> More
SQLAuthority News – Best Practices for Data Warehousing with SQL Server 2008 R2

as seen on SQL Authority - Search for 'SQL Authority'
An integral part of any BI system is the data warehouse—a central repository of data that is regularly refreshed from the source systems. The new data is transferred at regular intervals by extract, transform, and load (ETL) processes. This whitepaper talks about what are best practices for Data… >>> More

Related posts about doxygen

Exclude some classes from doxygen documentation

as seen on Stack Overflow - Search for 'Stack Overflow'
I am building a Qt based project, and many Qt classes are found in the target documentation. How can I tell Doxygen to disable documentation generation for some classes? For Q.*? >>> More
Doxygen C++ comment string parser in python?

as seen on Stack Overflow - Search for 'Stack Overflow'
Does anybody know of a python module to parse a doxygen style C++ comment string? I mean a string like this (simple example): /** * A constructor. * A more elaborate description of the constructor. * @param param1 test1 * @param param2 test2 */ and I would like to extract the brief… >>> More
Customizing doxygen output for the HTML Table of Contents

as seen on Stack Overflow - Search for 'Stack Overflow'
I'm using doxygen to generate an API reference from source code, aiming to convert it into a CHM help file and eventually into a plugin for Eclipse. Unfortunately the default ordering and nesting of the classes, namespaces, etc. in the Table of Contents is not exactly ideal and I'd prefer to customize… >>> More
GNU autoconf, document options using doxygen?

as seen on Stack Overflow - Search for 'Stack Overflow'
hi Is it possible to document configure.ac such that doxygen can pick up embedded comments and produce documentation for options, variables, etc. in generated manuals? Thanks >>> More
Is there any way to integrate doxygen with svn

as seen on Stack Overflow - Search for 'Stack Overflow'
Is there any way to configure doxygen to include the log from svn for a file as part of the output. Basically we enter pretty rigorous log messages into svn when we do commits, and I'd like those messages to have a section inside the doxygen output. >>> More