documentation

Create a diagram HTML5 HTML parsing algorithm

HTML5 describes an algorithm for parsing HTML. It is based on state machines. What is the best way to create a diagram for this algorithm? ...

Ubiquitous language - term for developers and users

Our project's team members are a big fans of Ubiquitous Language concept from the Domain-Driven Design Community. And here is the problem we've found: Non-techy users like to use a simplified names of all the concepts, they don't want to know all the details, and that's OK. But we can't do the same in code, because this concepts aren't...

Snow Leopard Reference Library

Hi, Does anyone know how to download all the developer reference documentation for snow leopard. For some reason Apple changed it so that whenever you wanted a document you have to get it form their website. I don't have an internet connection all the time so I would like to have all of the reference documentation locally on the desktop....

Need a good book(s) and information about working with unmanaged code and COM with .Net

I have been working with .Net since VS2002 and since then any time that I had to work with COM or unmanaged code has been a pain. I've succeeded doing what was expected but almost always doing a trial-error procedure. I've had enough of this and I want to know what's going on at the back room and understand how those things work. As us...

Platform ID in SERVER_INFO_101 Structure

Is there more precise documentation what PLATFORM_ID_DOS, PLATFORM_ID_OS2, PLATFORM_ID_NT, PLATFORM_ID_OSF, or PLATFORM_ID_VMS mean? The constants are defined in the lmcons.h file. Values can be got within the SERVER_INFO_100, SERVER_INFO_101, or SERVER_INFO_102 struct. Obviously PLATFORM_ID_NT means an NT-based platform. What's about...

How to generate facelets documentation

For JSP and some JSF tags there is a tool called TLDdoc that generates JavaDoc-style documentation for the JSP and JSF tags. Does anybody know an equivalent for Facelets? There is a tool called facelets-doc that aims to support Facelets but either it's not finished, or the lack of documentation doesn't mention how to make it work. I ha...

Is there a way to include body comments in javadocs?

We've got a large codebase of Java (with a smattering of Groovy mixed in) that, by and large, has no javadocs written for it. However, much of the code is reasonably well documented in "old-school" comments scattered throughout the body. We're now on something of a push to try and get things documented a little better - Javadocs are no...

Windows Standard File Locations

Could somebody point me to a document which lists all the standard file locations in windows and what one should and shouldn't use them for. Something like User Application Data -> %USERDIR%/AppData/Local/%VENDOR%/%APPLICATION% and so forth. ...

is there a documentation tool for wcf service?

Hi, I have used svcutil.exe to generate the service definition for a service that I am using. I want to produce an electronic document/help file from this output. are there ny tools for doing this? All I need to produce is simply the properties and methods of the objects exposed by the service thanks EDIT: I need to clarify that th...

Documentation Software

Hi to all, My teammates and I want to share some class documentation. Our idea is to have something in the vein of MSDN, with a hierarchical tree for our classes. The entries should be taggable and searchable and it should be easy to expand and be contributed to by multiple users (hence we're thinking of a web-based solution). The idea...

.NET XSD Documentation Generator

Hi, I'm looking for an XSD Documentation Generator for .NET. Please, provide any references. Note: If it is available with source code that would be much better choice. Thanks. ...

Documentation for large or small Projects with PHP ?

Hi, we are talking a lot about documentation for programmers in the moment. How do you handle this part? What is the best method to introduce a new team guy into an "large" PHP Project. What does a new guy need? My thoughts so far: good source code api documentation generated through phpdoc clear coding style / guideline Some kin...

how do you diagram relations between several services?

not necessary an UML diagram, just a simple way to graphically document the relations between several systems... the systems can be linked through web services, linked-servers, text files, batch processes, com+ components etc... I was thinking about a high level map, showing which system is consumming, exposing, resources and by which ...

What tools are available for documenting jQuery plugins?

Hi, I've recently started creating some jQuery plugins and I'm finding it difficult to document them with the documentation generating tools that I've found. I've tried: JSDoc, JSDoc-toolkit, JGrouse and a web-based tool also. My biggest headache is that my plug-ins are coded as one big anonymous function, and I'm having trouble getting...

How to document Web service for client

I am developing a web service. The business system of client will integrate with our system using these web service. I want to provide the documentation of our web service. What is the best practice for documenting the web service? ...

C/C++ function/method decoration

DISCLAIMER: I haven't done C++ for some time... Is it common nowadays to decorate C/C++ function/method declarations in order to improve readability? Crude Example: void some_function(IN int param1, OUT char **param2); with the macros IN and OUT defined with an empty body (i.e. lightweight documentation if you will in this example). ...

Adding a custom command in doxygen

I'd like to add a custom command to my doxygen documentation. Basically for each C function I'm writing doc for, I need to write which global variables are "touched" in read mode or write mode. It's like the "See also" list, just with a different caption. In my file I'd like to write something like this: /* * \read-globals #var1, #v...

Documenting & Tracking Requirements

When it comes to sizable software projects, what are the tools for managing requirements? Documenting Tracking Alarming Reporting Q1. Which one(s) do you use and why? Q2. Assuming you could switch to another platform, which one would it be? ...

Displaying inherited methods in rdoc

I have a program written in Ruby that uses multiple levels of inheritance. All of the parent classes have implemented methods that an object of a child class would use, but when I generate an rdoc for my program, the rdoc page for a child class only shows the methods for that specific class and no methods from the parent class. Does an...

How can we know what parameters are passed into a callback function in YUI?

From http://developer.yahoo.com/yui/docs/YAHOO.util.DataSourceBase.html#method_sendRequest,you can see the oCallback is an object literal with the following properties: success The function to call when the data is ready. failure The function to call upon a response failure condition. The problem is that it does not mention what paramet...