We are startingt o build the database fresh, lots of tables and fields to create for a social website. There will be heavy API implemntation so I am pushing the tech team for solid documentation of data schema, however lost on naming for fields and tables. I want it to all be user friendly, maybe specify the type of table it is also lik...
For a web service created in .NET, navigating to the service in a browser results in a somewhat brief listing of methods in the service and any description that is provided. Is there any way to customize the format of the documentation for .NET web services? Customization might include something as simple as customizing the styles on...
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...
I have looked over the MSDN site and I haven't been able to find C# indexer's documentation of a specific class For instance, I want to find HttpRequest's public string this[string key] documentation Where can i find it? ...
Consider that I have a complex class structure where many elements inherit from other elements. I may have a method GetStuff(string stuffName, int count) defined in an interface, which is inherited by other interface, which is then implemented abstractly by an abstract class, which is then implement explicit in a concrete class etc. etc....
I'am looking for an eclipse-plugin for doxygen code documentation. I have found the eclox-plugIn ( http://home.gna.org/eclox/ ). I would like find out, how can it automatically generate a "empty" doxygen comment, which could be filled out later or what is the better choice for a documentation eclipse plugIn? For example for a function: ...
I'm working on a complex data structure, think of it as an OODBMS storing single-user CAD info, and want a way to explain vulnerability points to justify where I'm locking and the scope of the critical sections that are being used. IO is via memory-mapping to files that are potentially opened multiple times in different threads. You cou...
Hi, I have a UAT test script for which I need to post some reference tables (excel sheet) in the appendix. The excel sheet has a lot of columns and doesn't fit into the MS Word document even when I paste the table in the landscape page set up. Is there any good way to paste such a huge table without making things too complex. I've trie...
This isnt much of a programming question. its more of a reference question: does anyone know any programs/text files/whatever that show how the Tiger hash works? im trying to find some way to see the intermediate values of the hash. i found this website but the java implementation is weird and shows incorrect values despite getting prop...
How to start the facebook application development using the Java API? I am getting into authentication issues? I could not find any proper documentation for java. Everything seems to be out dated. ...
Where is the difference between properties PageNumber and `PageCount in com.itextpdf.text.Document ? The documentation I have found on this is not very clear. *Note:*Same properties are also in class PdfWriter so I guess that those in Document only calls those in PdfWriter. ...
Is there any free software to automate documetnation process Sql Server DB. Creating Reports smth like this: TableName: (TableDescription) ColumnName, ColumnType, ColumnDescription, IndexInformation thanks. ...
I have a C program with multiple files, so I have, for example, stuff.c which implements a few functions, and stuff.h with the function prototypes. How should I go about documenting the functions in comments? Should I have all the docs in the header file, all the docs in the .c file, or duplicate the docs for both? I like the latter appr...
I've got some experience with git. In a new project, they decided to use hg. What documentation out there is most recommended to get started with hg quickly for an experienced git user? Most useful would be a short introduction in the parts where concepts differ as well as a comparison of the relevant command line calls. I am aware tha...
Where is it customary to write the in-code documentation of classes and methods? Do you write such doc-blocks above the corresponding class/method in the header (.hpp) file, or within the source (.cpp) file? Is there a widely respected convention for such things? Do most C++ projects do it one way rather than the other? Or sho...
I like to have one docbook xml document that has content for serveral target audiences. Is there a filter that enables me to filter out the stuff only needed for "advanced" users? The level attribute is invented by me to express what I have in mind. <?xml version="1.0"?> <book> <title lang="en">Documentation</title> <chapter...
When creating web projects (mostly XHTML/WORDPRESS THEMES) for sale on any given marketplace, what is the best way to go about writing technical manuals for users? ...
I am writing a man page for a program, the source looks like this: .TH prog 1 "26 AUG 2010" "Version 0.1" "Center header" .NAME prog \- runs a program .SH SYNOPSIS .B prog When I use $ groff -Tascii -man source.txt | more the output is pretty much as expected. When I use: $ groff -Tascii -man source.txt > prog.1 && \ sudo cp prog...
Hi, I am looking at commissioning a fairly straight forward restaurant directory and booking web app and I have had some quotes to use joomla and other OS CMS's as the base however I am thinking I like the idea of less clutter and more flexibility of a custom app. It will probably be cakePHP... I want to make sure that I have the rele...
We all have the good habit of documenting our code, right? Nowadays, in-code documentation itself has a syntax. It's almost like a programming language onto itself. The questions are: What (How many) documentation syntax specifications exist? Is there a standard documentation syntax? Who is defining this standard? Is there an of...