documentation

In JSDoc, the best documentation I can find shows to use the following if you have an array of a specific type (such as an array of strings) as: /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } How would you replace the below question marks specify an array of objects? /** * @param {???????} myObjects All of my equally awesome objects */ function blah(myObjects){ //stuff here... } Rene Saarsoo You should be more specific what you mean by JSDoc - this is a generic term covering pretty much all the JavaDoc-style documentation tools for

For ActionScript 2, I've used NaturalDocs . However it has pretty poor support for PHP. I've looked so far at doxygen and phpDocumentor , but their output is pretty ugly in my opinion. Does anyone have any experience with automatic documentation generation for PHP? I'd prefer to be able to use javadoc-style tags, they are short to write and easy to remember. ApiGen http://apigen.org/ ApiGen has support for PHP 5.3 namespaces, packages, linking between documentation, cross referencing to PHP standard classes and general documentation, creation of highlighted source code and experimental support

I inherited an existing API and I would like to document it with swagger, but I don't yet know the full scope of it. Can Swagger (or another middleware/tool) auto-magically generate the yaml (for swagger) based on the existing express routes? For what I saw on other questions, it would appear that this is mostly a manual job, but I'm double-checking if someone here found a way around this. I have experience in BOTH auto-generating the Swagger json and manually writing it out for an API that I helped build. Here are the pros/cons of both based on my experience. Swagger AUTOMATIC Documentation

Can anyone recommend a program to create user manuals with? Not a markup language (like LaTeX or DocBook) but more something interactive like Scribus. As I'm not the only one that will update the manual the software should be something that's easy for a novice to pick up but still has some advanced features (like linking in text from external sources/tables, handling masterpages/themes etc.). Regards, Oscar ConcernedOfTunbridgeWells Technical Publishing Software - Views on FrameMaker and Its Alternatives I've done spec documents with LaTeX and Framemaker, and designed a Framemaker workflow to

Do you often see in API documentation (as in 'javadoc of public functions' for example) the description of "value limits" as well as the classic documentation ? Note: I am not talking about comments within the code By "value limits", I mean: does a parameter can support a null value (or an empty String, or...) ? does a 'return value' can be null or is guaranteed to never be null (or can be "empty", or...) ? Sample: What I often see (without having access to source code) is: /** * Get all readers name for this current Report. <br /> * <b>Warning</b>The Report must have been published first. *

I am trying to document a package in Python. At the moment I have the following directory structure: . └── project ├── _build │ ├── doctrees │ └── html │ ├── _sources │ └── _static ├── conf.py ├── index.rst ├── __init__.py ├── make.bat ├── Makefile ├── mod1 │ ├── foo.py │ └── __init__.py ├── mod2 │ ├── bar.py │ └── __init__.py ├── _static └── _templates This tree is the result of the firing of sphinx-quickstart . In conf.py I uncommented sys.path.insert(0, os.path.abspath('.')) and I have extensions = ['sphinx.ext.autodoc'] . My index.rst is: .. FooBar documentation master file, created by

Is there any documentation on the parameters to WebForm_PostBackOptions? I can't find anything by Googling. There is no official documentation on this. However if you look at the javascript source code you will see this: function WebForm_PostBackOptions(eventTarget, eventArgument, validation, validationGroup, actionUrl, trackFocus, clientSubmit) I think the parameter names are quite self-explanatory. Look at the javascript decleration as Gh0sT said: function WebForm_PostBackOptions(eventTarget, eventArgument, validation, validationGroup, actionUrl, trackFocus, clientSubmit) Then look at the