JSDOC/ScopeNamer.js

[app.jsdoc] / README.txt

diff --git a/README.txt b/README.txt
index cb5529d..bb01ecf 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -1 +1,80 @@
-No readme yet
\ No newline at end of file
+JSdoc
+
+
+Tool used to document Roojs, and some seed code.
+
+
+Testing with RooJS:
+ - "namespacing" - need to compare dir-replaced with actual classname
+    -- if they match ignore the 'dirname part'
+
+file preview is using full path?
+
+ 
+--------------------------------------------------
+
+Scope namer issue still:
+ - basically it's trying to guess the scope name.
+ - it's doing a so-so job of it..
+ ** It's not pretty though...
+ 
+ Classic example:
+    Date.monthNames = {
+       Jan : ....
+    }
+
+This could be an object.. so it get's put in the tree as available to document.
+  We could solve this in a number of ways
+    a) a tag on the code to indicate that it's not to be documented..
+    b) ?? how else ?? - we can not determine it simply..
+
+
+
+
+---------------- VVVV the old stuff VVVVV --------------
+
+
+
+New ScopeNamer
+-----------------------------------
+Supposed to be simpler than old walker code, as it uses the collapsed tree
+to build documentation.
+
+Current issues
+ - Needs to use filename to build tree
+ - extends resolution needs plan...
+ - need to add import line to output..
+ - how to handle namespaces properly..
+   - in standard JS, we can just use the full names,
+   - in seed, we need to use the filename to reference it..
+    = This fact has to be either explained in the code,
+    = or at doc building time.??
+
+
+Seed
+--------------------------------------------
+Issues:
+- import.JSDOC.BuildDocs.BuildDocs
+
+Unlike standard javascript, each file has it's own scope,
+.. we could choose to ignore this..
+.. as since we have 'srcFile', that could be used to determine the 'import'
+.. example.
+
+In this case namespace is really a way to group them in the tree.
+
+... otherwise, we could actually use the directory structure to decide how to do the
+... the displayed tree, and use namespace correctly...
+
+This makes more sense..
+
+However, we need to reference other files, so we should use
+
+So
+   JSDOC.BuildDocs.BuildDocs
+   @namespace JSDOC.BuildDocs
+   @class BuildDocs
+   -- 
+
+=> Technically
+   "JSDOC.BuildDocs"
\ No newline at end of file