Various docs fixes.

It turns out we weren't documenting o3djs.math.matrix4
because it was missing an @namespace tag. I tried to
find a way to flag this as an error but as far as can 
tell there, in jsdoctoolkit there is nothing I can use
to distinguish between a function with no parameters
and returns nothing and an un tagged namespace.

In other words

/**
 * no tag here
 */
o3djs.foo.someNamespace = { };

..and..

/**
 * Some func.
 */
o3djs.foo.someFunc = function() { };

Look exactly the same when they get to the doc generation
part of jsdoctoolkit. Both are members of o3djs.foo.
Both have no params and no return type. So I can't tell
that the first one is an error (a non function with no tags)
and the second one is not.

I guess we just have to be vigilant.

Also, a BIG error was I wasn't generated o3djs docs at all
in build_docs.py. Fixed that.

Finally I changed the format some. My opinion was the
summary docs at the top of each module/class were hard
to read so I put them in tables. Will have to check with
Josie once it's checked it now they actually appear on
her test server.

Also made it so for module methods and properties they
get documented as

o3djs.module.method
o3djs.module.property

but for object methods and properties they get documented

ObjectName.method
ObjectName.property

Both used to be documented as just 

method
property

Which I found hard to read since there is no context.



Review URL: http://codereview.chromium.org/149523

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@20511 0039d316-1c4b-4281-b951-d872f2087c98

3 files changed, 11 insertions, 1 deletions

diff --git a/o3d/samples/o3djs/base.js b/o3d/samples/o3djs/base.js
index 4807397..ff86e42 100644
--- a/o3d/samples/o3djs/base.js
+++ b/o3d/samples/o3djs/base.js
@@ -648,6 +648,7 @@ o3djs.base.maybeDeobfuscateFunctionName_ = function(name) {
 o3djs.base.inherit = function(subClass, superClass) {
   /**
    * TmpClass.
+   * @ignore
    * @constructor
    */
   var TmpClass = function() { };
diff --git a/o3d/samples/o3djs/particles.js b/o3d/samples/o3djs/particles.js
index 324d85a..051729f 100644
--- a/o3d/samples/o3djs/particles.js
+++ b/o3d/samples/o3djs/particles.js
@@ -322,6 +322,9 @@ o3djs.particles.createParticleSystem = function(pack,
  *     else.
  * @param {!o3d.ParamFloat} opt_clockParam A ParamFloat to be the default
  *     clock for emitters of this particle system.
+ * @param {!function(): number} opt_randomFunction A function that returns
+ *     a random number between 0.0 and 1.0. This allows you to pass in a
+ *     pseudo random function if you need particles that are reproducable.
  */
 o3djs.particles.ParticleSystem = function(pack,
                                           viewInfo,
diff --git a/o3d/samples/o3djs/performance.js b/o3d/samples/o3djs/performance.js
index e81396f..92865e5 100644
--- a/o3d/samples/o3djs/performance.js
+++ b/o3d/samples/o3djs/performance.js
@@ -39,6 +39,12 @@
 o3djs.provide('o3djs.performance');

 

 /**

+ * A Module to help with adjusting performance.

+ * @namespace

+ */

+o3djs.performance = o3djs.performance || {};

+

+/**

  * Creates a utility that monitors performance [in terms of FPS] and helps to

  * adjust the rendered scene accordingly.

  * @param {number} targetFPSMin the minimum acceptable frame rate; if we're

@@ -155,7 +161,7 @@ o3djs.performance.PerformanceMonitor = function(
  * @type {{

  *   opt_minSamples: number,

  *   opt_damping: number,

- *   opt_delayCycles, number

+ *   opt_delayCycles: number

  * }}

  */

 o3djs.performance.PerformanceMonitor.Options = goog.typedef;