Documenting Complex Project #132

Activity

1. tmcw commented on Jul 29, 2015

   

   tmcw

   on Jul 29, 2015

   Member

   More actions

   Right now there are two modes for documentationjs:

   • Polyglot mode, which takes lists of filenames as input and parses files agnostically
   • JavaScript mode, which takes files as input, crawls their dependencies, and parses them as JavaScript

   to document cross-language repositories, we would need to separate the input step from the parsing step and have the parser decide on JavaScript vs C++ based on extension or some other cue.
2. elwayman02 commented on Nov 3, 2015

   

   elwayman02

   on Nov 3, 2015

   More actions

   @tmcw is it possible to simply provide a directory and have documentationjs parse all files in that directory?
3. tmcw commented on Nov 3, 2015

   

   tmcw

   on Nov 3, 2015

   Member

   More actions

   @elwayman02 sure, you can do

   documentation --polyglot directory/*

   As previously discussed, though, this uses the polyglot parser that does not do any code inference - to infer JS and polyglot-parse other types, we might need some sort of filename sniffing.
4. elwayman02 commented on Nov 3, 2015

   

   elwayman02

   on Nov 3, 2015

   More actions

   @tmcw I get this error when I try that:

   $ documentation -f html -o docs --polyglot addon/*
   fs.js:552
     var r = binding.read(fd, buffer, offset, length, position);
                     ^
   Error: EISDIR, illegal operation on a directory
       at Error (native)
       at Object.fs.readSync (fs.js:552:19)
       at Object.fs.readFileSync (fs.js:384:28)
       at /usr/local/lib/node_modules/documentation/lib/input/shallow.js:26:20
       at Array.map (native)
       at module.exports (/usr/local/lib/node_modules/documentation/lib/input/shallow.js:23:33)
       at module.exports (/usr/local/lib/node_modules/documentation/index.js:80:10)
       at Object.<anonymous> (/usr/local/lib/node_modules/documentation/bin/documentation.js:19:1)
       at Module._compile (module.js:460:26)
   
5. tmcw commented on Nov 3, 2015

   

   tmcw

   on Nov 3, 2015

   Member

   More actions

   There's probably a directory in that directory and documentation's trying to read it. We do not currently recurse down directories.
6. elwayman02 commented on Nov 3, 2015

   

   elwayman02

   on Nov 3, 2015

   More actions

   Ah, yea there definitely is. That's what I'm ultimately looking for; I'd like to take a complex project and input the parent directory, getting back generated documentation for all the files
7. tmcw

   added

   enhancement

   on Jan 24, 2016
8. tmcw commented on Dec 9, 2016

   

   tmcw

   on Dec 9, 2016

   Member

   More actions

   Going to rename this module to reflect the idea that maybe normal mode and polyglot mode shouldn't be mutually exclusive. For the immediate issue - this illegal operation thing:

   • For now, use recursive globs: documentation --polyglot directory/**
9. tmcw

   added 2 commits that reference this issue on Jul 27, 2017

   revert(polyglot): Remove polyglot mode

   ...

   This issue will close once commit 3ba5ffe is merged into the 'master' branch.

   3ba5ffe

   revert(polyglot): Remove polyglot mode

   ...

   This issue will close once commit 7b982ea is merged into the 'master' branch.

   7b982ea
10. tmcw

    closed this as completedin #851on Jul 27, 2017
11. tmcw

    added a commit that references this issue on Jul 27, 2017

    revert(polyglot): Remove polyglot mode

    ...

    This issue will close once commit 5b373ff is merged into the 'master' branch.

    5b373ff
12. rhendric

    added a commit that references this issue on Sep 15, 2022

    Fix typos (documentationjs#132)

    ad775e6