Basic question here, but how would I reference the following (ie does it have a name). I looked on msdn and all I could find was they called is XML Documentation, which seems a bit misleading. /// <summary> /// This is a simple summary for my class /// </summary> /// <param name="foo"></param> /// <param name="bar">...
Currently the documentation where I work is in a bit of a state. There isn't anywhere near enough of it, and the documentation that does exist is spread out over many word documents making it hard to find anything. I'm trying to take some initiative and get it improved, and I figure the first thing is to find a better format to write ...
Hello, Does anyone know where can I find the documentation source for the PHP functions? (Something like XML files would be great!) thanks ...
I'm sharing documentation with people not programming oriented. We agree we need a documentation repository but they don't like TortoiseSVN as it lacks some features that they consider key issues: Lock of files in such a way that everybody knows is blocked (more like VSS) To see files that are being changed by other people, even though...
I am working on a new library and I am using XML comments for API documentation along with SandCastle which works really well. But I need to write additional documentation which covers concepts, overall architecture, working demos etc, class diagrams etc. I have 2 options: Use some wiki engine and write documentation wiki style. Use ...
Greetings, When I try to use Ruby's ri tool in a command prompt window to acquire information about classes, methods, etc. it seems to always fail. For example if I type ri Array I get a message saying Updating class cache with 0 classes... Nothing known about Array What should I do to configure Ruby's ri tool to work? Thanks. ...
Does anyone have documentation pertaining to learning the fundamentals of Linux x86-64 assembly? I'm not sure whether or not to learn it as is, or to learn x86 first, and learn it later, but being as I have an x86-64 computer and not an x86, I was thinking of learning x86-64 instead ;) Maybe someone could give me some incentive, and di...
I am not sure if this makes sense so apologies before hand: is there a markup language specifically for creating document specifications? For example, if instead of giving people a template Word document for a given document they need to create, supply them with the specification in the markup language on what the document has to contain...
What's your feeling about those two? ...
Here is the confusing page. Search for "/bin/ps". The line is: ProcessHandle ph(launch("/bin/ps", args, &outPipe, 0, 0)); Shouldnt it be: ProcessHandle ph(launch("/bin/ps", args, 0, &outPipe, 0)); ? ...
How much percent of time do you spend on documentation per day as software developer and ideally how much time should given to documentation ? ...
I don't have much experience with documentation tools like doxygen, so I'm not sure exactly how in-code documentation should look. Should I write doxygen-style comments for each member variable in a class? Or is this overkill if the variable names are fairly self-explanatory? Should I include the comments from a header in the correspon...
Aside from the Microsoft documentation, does anyone know of a good introduction and tutorial to the Microsoft Reactive (Rx) framework? Also, could someone articulate a good example (with code) of a programming problem that is challenging to solve using conventional asynchronous coding techniques that Reactive makes easier. ...
I am looking for something that will iterate over our model and extract each objects properties in order to build a documentation wiki. Is there a tool out there which will do such a thing? Basically I do not want to have to extract all of our documentation out of the projects by hand. ...
I am looking at any document generator for PHP that can actually read the source code and generate the documentation - instead of writing comments according to what the generator needs the format to be like. I've looked at phpDocumentor and several other documentation generators: all require the need of writing comments into the source ...
Hi, Does anyone know where to find informations about streaming protocols supported by Android. As I have to write an official documentation I don't want to rely on any blog post and would like to find the official Android (Google) specifications. Thanks! ...
I found some struct initialization code yesterday that threw me for a loop. Here's an example: typedef struct { int first; int second; } TEST_STRUCT; void testFunc() { TEST_STRUCT test = { second: 2, first: 1 }; printf("test.first=%d test.second=%d\n", test.first, test.second); } Surprisingly (to me), here's the...
How can you use Sphinx for Python 3.x documentation? http://doc.python.org/3.1 seem to have managed it. ...
I am creating internal documentation for a C++ project using Doxygen. I am having Doxygen include the source for methods, etc, but this makes the page kind of hard to scan. I'd like it to behave like rdoc and hide the source in a block that is collapsed by default. I thought that HTML_DYNAMIC_SECTIONS might let me do this, but alas, the...
I'm taking Joel's suggestion to heart and will be trying to write something engaging, funny and fun to read. I have been recently inspired by why's Poignant Guide (what happened to that guy btw?), and while I am not nearly as talented, I do actually exist. Have you guys seen any other examples of great and interesting docs you'd care to...