How to document the analysys of a library

Posted by Marcos Perez on Stack Overflow See other posts from Stack Overflow or by Marcos Perez
Published on 2010-05-19T02:11:01Z Indexed on 2010/05/19 2:20 UTC
Read the original article Hit count: 495

Filed under:

library

|

documentation

Hi, I want to know if there's any "wide applied" documenting method for the documentation of the libraries, like use cases. Thanks Marcos

© Stack Overflow or respective owner

Related posts about library

Residual packages Ubuntu 12.04

as seen on Ask Ubuntu - Search for 'Ask Ubuntu'
I have an Asus Q500A with win8 and Ubuntu 12.04 64 bit; Linux kernel 3.8.0-32-generic. I have been having residual package issues which have been giving me trouble trying to reconfigure xserver-xorg-lts-raring. I tried removing all residual packages from synaptic but the following were not removed… >>> More
can't install psycopg2 in my env on mac os x lion

as seen on Server Fault - Search for 'Server Fault'
I tried install psycopg2 via pip in my virtual env, but got this error: ld: library not found for -lpq (full log here: http://pastebin.com/XdmGyJ4u ) I tried install postgres 9.1 from .dmg and via port, (gksks)iMac-Alexander:~ lorddaedra$ locate libpq /Developer/SDKs/MacOSX10.7.sdk/usr/include/libpq /Developer/SDKs/MacOSX10… >>> More
Library as dependence for other library

as seen on Stack Overflow - Search for 'Stack Overflow'
Hello guys, I have a big project compiled into libProject.so-file (shared library), I made some modules (shared libraries too) which use code from all libProject. Can I set libProject as dependence for moduleProject.so file? (gcc) >>> More
WCF Service Library vs Class Library project types

as seen on Stack Overflow - Search for 'Stack Overflow'
What does a WCF Service Library do that a regular class library doesn't? edit: i posted my own answer. Am I missing anything? Are they fundamentally both just class libraries with a few template classes added? >>> More
Library as dependency for another library

as seen on Stack Overflow - Search for 'Stack Overflow'
Hello guys, I have a big project compiled into libProject.so-file (shared library), I made some modules (shared libraries too) which use code from all libProject. Can I set libProject as dependence for moduleProject.so file? (gcc) >>> More

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 – Statistics Used by the Query Optimizer in Microsoft SQL Server 2008 – Microsoft Whitepaper

as seen on SQL Authority - Search for 'SQL Authority'
I recently presented session on Statistics and Best Practices in Virtual Tech Days on Nov 22, 2010. The sessions was very popular and I got many questions right after the sessions. The number question I had received was where everybody can get the further information. I am very much happy that my… >>> More