git.roojs.org Git - app.jsdoc/blob - README.txt

   1 JSdoc
   2
   3
   4 Tool used to document Roojs, and some seed code.
   5
   6
   7 Testing with RooJS:
   8  - "namespacing" - need to compare dir-replaced with actual classname
   9     -- if they match ignore the 'dirname part'
  10
  11 file preview is using full path?
  12
  13
  14 --------------------------------------------------
  15
  16 Scope namer issue still:
  17  - basically it's trying to guess the scope name.
  18  - it's doing a so-so job of it..
  19  ** It's not pretty though...
  20
  21  Classic example:
  22     Date.monthNames = {
  23        Jan : ....
  24     }
  25
  26 This could be an object.. so it get's put in the tree as available to document.
  27   We could solve this in a number of ways
  28     a) a tag on the code to indicate that it's not to be documented..
  29     b) ?? how else ?? - we can not determine it simply..
  30
  31
  32
  33
  34 ---------------- VVVV the old stuff VVVVV --------------
  35
  36
  37
  38 New ScopeNamer
  39 -----------------------------------
  40 Supposed to be simpler than old walker code, as it uses the collapsed tree
  41 to build documentation.
  42
  43 Current issues
  44  - Needs to use filename to build tree
  45  - extends resolution needs plan...
  46  - need to add import line to output..
  47  - how to handle namespaces properly..
  48    - in standard JS, we can just use the full names,
  49    - in seed, we need to use the filename to reference it..
  50     = This fact has to be either explained in the code,
  51     = or at doc building time.??
  52
  53
  54 Seed
  55 --------------------------------------------
  56 Issues:
  57 - import.JSDOC.BuildDocs.BuildDocs
  58
  59 Unlike standard javascript, each file has it's own scope,
  60 .. we could choose to ignore this..
  61 .. as since we have 'srcFile', that could be used to determine the 'import'
  62 .. example.
  63
  64 In this case namespace is really a way to group them in the tree.
  65
  66 ... otherwise, we could actually use the directory structure to decide how to do the
  67 ... the displayed tree, and use namespace correctly...
  68
  69 This makes more sense..
  70
  71 However, we need to reference other files, so we should use
  72
  73 So
  74    JSDOC.BuildDocs.BuildDocs
  75    @namespace JSDOC.BuildDocs
  76    @class BuildDocs
  77    --
  78
  79 => Technically
  80    "JSDOC.BuildDocs"