Top "Code-documentation" questions

Documentation that focuses on code itself, such as its function, correct use, expected output, relationship to other code as well as database and tables connections, and usage examples.

NoMethodError: undefined method `match?' for "Ruby":String

I'm trying to check whether input from user matches RegEx [a-zA-z] so I've checked the docs for proper method. I …

ruby regex match nomethoderror code-documentation
PHPdoc - defining object properties for an object of stdClass

I am trying to figure out if it is possible to use PHPdoc to define the object properties being returned …

php phpdoc code-documentation
JSDoc - how to document prototype methods

I've been trying to document the following code using JSDoc: /** * @module person */ /** * A human being. * @class * @param {string} name */ function …

javascript documentation-generation jsdoc code-documentation jsdoc3
Create "Quick Help" Entry in Xcode

How do I create quick help entries in Xcode for my own code? I just want it as a coding …

objective-c xcode doxygen comments code-documentation
PHPDoc: Typehint in nested arrays (with e.g. 2 dimensions)

Is there a correct way to document values/objects in arrays which are within another dimension? Normally an array will …

php arrays phpdoc code-documentation
doxygen is generating empty documentation

I have a source repository in C++ (and some CUDA), which I want to doxygenate. I've added doxygen comments to …

c++ doxygen code-documentation
Should I write multiple @return tags in javadoc

Say I have a java method that returns an array of strings. Inside the method, I have more than one …

java return javadoc code-documentation
Where is the documentation of Selenium Webdriver for NodeJS?

I don't seem to find any, the only one I always find is this one: https://code.google.com/p/…

node.js selenium selenium-webdriver documentation code-documentation
How to document return in JavaScript

I'm writing my own library for the project at work for a browser application and I am having the same …

javascript google-closure-compiler jsdoc code-documentation
Using Appledocs to generate documentation

I apologize for the simplicity of my question, but I was trying to generate documentation using Appledocs (https://github.com/…

ios objective-c xcode documentation-generation code-documentation