summaryrefslogtreecommitdiffstats
path: root/o3d/documentation/jsdoc-toolkit-templates
Commit message (Collapse)AuthorAgeFilesLines
* Changes the classlist to be hierarchical.gman@chromium.org2009-12-082-5/+68
| | | | | | Review URL: http://codereview.chromium.org/460097 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@34095 0039d316-1c4b-4281-b951-d872f2087c98
* Fixes a bug in the docs generation for overloadedgman@chromium.org2009-12-043-9/+29
| | | | | | | | | | | | | | | | | | functions. The issue is that JavaScript has no concept of overloaded functions. Nixysa was merging them for compilation by the JSCompiler but it needs to keep them separate for docs. To fix the issue an option was added to nixysa to rename overloaded functions with the suffix xxxOVERLOAD<num>xxx. The docs generators then remove the suffix where appropriate. Review URL: http://codereview.chromium.org/462039 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@33859 0039d316-1c4b-4281-b951-d872f2087c98
* Fix 2 issues in docs buildinggman@chromium.org2009-11-301-12/+12
| | | | | | | | | | | 1) Object type specifications "Object<index, type>" were broken 2) The js compiler would create a partial base.js even on failure which means the next build would skip building the docs. Review URL: http://codereview.chromium.org/457011 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@33366 0039d316-1c4b-4281-b951-d872f2087c98
* Made all line endings consistently LF and added svn:eol-style=LF property to ↵apatrick@google.com2009-11-121-34/+34
| | | | | | | | | | | | | | | | | | | | | | | | | | files with these names / extensions. c cc h mm txt idl py js html css gyp gypi xml shader json htm README DEPS git-svn-id: svn://svn.chromium.org/chrome/trunk/src@31811 0039d316-1c4b-4281-b951-d872f2087c98
* Generates a class hierarchy using graphviz "dot", thegman@google.com2009-09-032-0/+25
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | same tool that doxygen uses. This is not ready for primetime but I had already looked at this and it didn't look to hard so I stuck it in. With this CL nothing will happen unless graphviz is added to third_party/graphviz/files but I wanted to at least check in what has to happen so that if someone else wants to finish it they can. Basically jsdoctoolkit generates a .dot file that lists the inheritance, that is passed to dot which creates a png and a map file for a client side image map. To actually use it online would require inserting the map file into an html file, probably using EZT or python. Otherwise, to be useful we'd need to split the template into ParamMatrix4 and its derived classes, Param and its derived classes. RenderNode and its derived classes, ParamObject and its derived classes and then finally everything not covered by the above. Otherwise the chart is too big. http://www/~gman/images/class_hierarchy.png To be honest though, given it's just a tree a simple HTML page could also do this without the graphing. Just a simple -NamedObject | +-Param | +--ParamFloat | +--ParamInteger etc. Nearly as simple would be to save the data to JSON and graph it in JavaScript live in the browser using canvas or O3D. That would be a lot smaller than the 9meg for the binary parts of graphviz Review URL: http://codereview.chromium.org/174384 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@25315 0039d316-1c4b-4281-b951-d872f2087c98
* Fix for archive request. It turns out this thinggman@google.com2009-08-312-4/+18
| | | | | | | | | | | | | | can be called recursively. Because of that ArchiveRequest::raw_data_ would be invalid when the outer call came back. This way we mostly don't use that field. Also updated the docs so it can me marked as deprecated. Review URL: http://codereview.chromium.org/173620 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@24906 0039d316-1c4b-4281-b951-d872f2087c98
* Added o3djs.util.getElementsByTagAndId andgman@google.com2009-08-211-22/+86
| | | | | | | | | | | | | | | | o3djs.util.getO3DContainerElements which encasplulates the way we were finding elements to make O3D tags in. I also put an example of how to make your own failure callback in the docs. This also brought up a known issue in the doc generator so that fix is included here. Review URL: http://codereview.chromium.org/173178 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@23976 0039d316-1c4b-4281-b951-d872f2087c98
* A bunch more docs fixesgman@google.com2009-08-193-2/+21
| | | | | | Review URL: http://codereview.chromium.org/171070 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@23679 0039d316-1c4b-4281-b951-d872f2087c98
* Added default values to property documentation.gman@google.com2009-08-051-32/+65
| | | | | | | | Fixed a few more docs issues. Review URL: http://codereview.chromium.org/159894 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@22463 0039d316-1c4b-4281-b951-d872f2087c98
* The compiled version of the o3djs libs WORK!gman@google.com2009-07-202-4/+80
| | | | | | | | | | | | | | | | | | | Sadly there is some really strange voodoo to make it work. util.js was using document.getElementsByTagName('script') and it was not returning all the scripts. Lots of dump() lines later the voodoo of calling document.getElementsByTagName('script').length (the length is important) in some place earlier in the code fixes the issue. Also, added the copyright to the compiled file Added parameter docs Review URL: http://codereview.chromium.org/159049 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@21085 0039d316-1c4b-4281-b951-d872f2087c98
* missing filegman@google.com2009-07-171-0/+33
| | | | git-svn-id: svn://svn.chromium.org/chrome/trunk/src@20939 0039d316-1c4b-4281-b951-d872f2087c98
* JSCompiler fixesgman@google.com2009-07-161-4/+41
| | | | | | | | | | | | | | | | | *) Generate goog.exportSymbol for all o3djs classes, methods and properties so the JSCompiler does not delete them *) Remove goog.exportSymbol from the compiled result. *) Remove o3djs.require from the compiled result. *) Add docs to undocumented items in o3djs. Review URL: http://codereview.chromium.org/155665 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@20919 0039d316-1c4b-4281-b951-d872f2087c98
* quick fix for bad checkingman@google.com2009-07-151-3/+3
| | | | git-svn-id: svn://svn.chromium.org/chrome/trunk/src@20813 0039d316-1c4b-4281-b951-d872f2087c98
* More docs changes.gman@google.com2009-07-156-40/+279
| | | | | | | | | | | | | | | *) Made enums show up *) Right justified return type *) moved class name to right column in summary area *) pretty print code examples *) changed [inherited] to [inhertied from <class>] *) Changed name in details area to Class.Name or Namespace.Name *) Add subtypes so ParticleEmitter shows up in docs for o3djs.particle *) Grabbed new nixysa so properties show up Review URL: http://codereview.chromium.org/155600 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@20806 0039d316-1c4b-4281-b951-d872f2087c98
* Lots more docs changes.gman@google.com2009-07-1412-24/+440
| | | | | | | | | | | | | | | | | | | *) added stylesheet.css, tabs.css, tab_?.gif back in *) refactored so classtree.html splits names that are too long. *) removed constructor docs and source link from o3d docs (vs o3djs docs) *) fixed paths in header.html. They used to be statically included but now that they are used by both o3d and o3djs they needed to have certain paths fixed dynamically. *) Pull in new nixysa. Review URL: http://codereview.chromium.org/155526 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@20645 0039d316-1c4b-4281-b951-d872f2087c98
* Yet more docs.gman@google.com2009-07-142-4/+15
| | | | | | | | | | | | Changed to put them in a folder called "reference" since that is what Josie needs to publish without renaming. Also fixed a few path issues. Review URL: http://codereview.chromium.org/155467 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@20582 0039d316-1c4b-4281-b951-d872f2087c98
* A few more docs updates.gman@google.com2009-07-131-10/+11
| | | | | | Review URL: http://codereview.chromium.org/155461 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@20562 0039d316-1c4b-4281-b951-d872f2087c98
* Various docs fixes.gman@google.com2009-07-132-35/+73
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* This CL contains the the changes needed to buildgman@google.com2009-06-302-60/+132
| | | | | | | | | | an externs file for the JSCompiler as well as the code to build a compiled verison of the o3djs sample libs. Review URL: http://codereview.chromium.org/147079 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@19659 0039d316-1c4b-4281-b951-d872f2087c98
* Fix the < sign to &lt; in jsdocsgman@google.com2009-06-261-1/+1
| | | | | | Review URL: http://codereview.chromium.org/149104 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@19427 0039d316-1c4b-4281-b951-d872f2087c98
* Undoing gcl bug damage AGAINgman@google.com2009-06-171-36/+29
| | | | git-svn-id: svn://svn.chromium.org/chrome/trunk/src@18600 0039d316-1c4b-4281-b951-d872f2087c98
* adding svn:ignore properties to ignore .o3dtgzgman@google.com2009-06-171-29/+36
| | | | | | | files as well as scons-out etc... git-svn-id: svn://svn.chromium.org/chrome/trunk/src@18599 0039d316-1c4b-4281-b951-d872f2087c98
* Undoing gcl bug damagegman@google.com2009-06-171-36/+29
| | | | git-svn-id: svn://svn.chromium.org/chrome/trunk/src@18598 0039d316-1c4b-4281-b951-d872f2087c98
* Adds a bunch of svn:ignore properties so that svn statusgman@google.com2009-06-171-29/+36
| | | | | | | doesn't show stuff we don't care about. git-svn-id: svn://svn.chromium.org/chrome/trunk/src@18595 0039d316-1c4b-4281-b951-d872f2087c98
* This is the O3D source tree's initial commit to the Chromium tree. It gspencer@google.com2009-05-279-0/+1152
is not built or referenced at all by the chrome build yet, and doesn't yet build in it's new home. We'll change that shortly. git-svn-id: svn://svn.chromium.org/chrome/trunk/src@17035 0039d316-1c4b-4281-b951-d872f2087c98
generated by cgit v1.1 at 2025-01-19 21:58:22 +0000