Quick Code Documentation

Documentation of Code seem the least "productive" task but it is important. I have always been adding comments in the code but until today, I couldn't find a "great" tool that could do more than just copying my comments and display in an auto-generated documentation.

Then, here is what I found, an automated documentation generating tool:
1. Download and install "Doxygen"
http://www.stack.nl/~dimitri/doxygen/index.html

2. Install GraphViz (open source majorly funded by AT&T)
http://www.graphviz.org/

3. While generating the documentaion through "Doxygen", mention "Use dot tool from the GraphViz Package" option if you are on the Wizard > Diagrams tab.

4. Create Folder in which you want to have the documentation generated and specify other preferences.

5. You'll have to select "Run" tab and say "Run Doxygen" to generate to documentation.

Open "Index.html" to start viewing the documentation!

The tool is so good that it allows you to create Class Diagrams, Inheritence Diagram, UML Diagrams and more all by looking at the code.

Have Fun!

Comments

Post a Comment

Feel free to give constructive feedback or let me know if it was helpful.

Popular posts from this blog

Unable to delete Shared Services Provider in SharePoint (MOSS)

Sometimes The SSP you create in MOSS are not created properly. This can be result of interruption while SSP was being created or in result of bad migration from SPS03 or MCMS to MOSS. Symptoms: 1. In left nav of SharePoint Central Administration, the name of your new SSP will not render rather, it will show up as text. 2. If you try to delete that from the Central Admin, the Delete option is disabled. Resolution: You should delete the SSP using stsadm command line tool (NOTE: My SSP's name is "SSP" which is specified after "title" in command: C:\Program Files\Common Files\Microsoft Shared\web server extensions\12\BIN>stsa dm -o deletessp -title "SSP" However, if you have any dependencies, you will have to delete them first or you will get following error when you try deleting it through command line tool: An object in the SharePoint administrative framework, "SharedResourceProvider Na me=SSP Parent=SPFarm Name=SharePoint_Config...
Read more

Cannot add a SimpleContent column to a table containing element columns or nested relations

Recently I ran into a problem while dealing with DataSets. I was adding a colum to an XSD through Visual Studio desinger and it kept failing with following error: Cannot add a SimpleContent column to a table containing element columns or nested relations. This is a known issue. However, the solution is not well known :) To be simple and streight forward, I tell you the solution which I tried and it worked, 1. Note down the column names, datatypes and relationships of the table. 2. Delete the table. 3. Add new table and add columns to it. 4. Redefine relationships. Best of luck.
Read more

The server was unable to process the request due to an internal error. For more information about the error, either turn on IncludeExceptionDetailInFaults (either from ServiceBehaviorAttribute or from the configuration behavior) on the server in order to send the exception information back to the client, or turn on tracing as per the Microsoft .NET Framework 3.0 SDK documentation and inspect the server trace logs.

Image
  While configuring the SharePoint 2010 for Forms Based Authentication, I encountered above error. To get the problem, I had to change “IncludeExceptionDetailInFaults” to true somewhere. But WHERE? Here is what solved my problem: Go to following path: 1. C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\WebServices\SecurityToken 2. Open Web.config there. 3. Add following in the “behaviors > serviceBehaviors > behavior” node. <serviceDebug includeExceptionDetailInFaults="true"/> Now try to login and see what error it gives, off to a next error
Read more