Replace -rr with just -r?

[mrjoelkemp]

@vdeturckheim What's the difference between --recursive and --respect-recursive? If I did jsdox -r inputDir -o outputDir I'd expect the output directory to have the same structure as the input directory.

[boneskull]

@mrjoelkemp Are you asking me? I have no idea. 😄

It appears -r plops everything in one directory and -rr will do what you are talking about.

[mrjoelkemp]

@boneskull Your original PR was so epic that I assumed you had implemented this. Sorry about that :) Corrected the cc.

[boneskull]

@mrjoelkemp If only all of my PRs were that way...

@psq I'm not really understanding the use case of jsdox against anything but very small codebases. If you have one file, you can generate a README.md from it (sort of; the file won't be named README.md and it won't go where you want, but that's another open issue). If you have multiple files, you get a directory (or directory hierarchy) full of Markdown files.

Is the user to browse them individually? They don't make a web site. They can't be used with Jekyll because they have no Front Matter. You could potentially create an entire GitHub wiki out of the non-hierarchical files (using -r; not -rr), but a wiki is not really suitable for API documentation. Does some other converter consume them and turn them into a PDF?

I've only used jsdox for a very small module or two b/c of its limitations. If it generated a Jekyll site (and had more tag support, of course), then it's a viable alternative to jsdoc itself.

[mrjoelkemp]

@boneskull Moving the use-case discussion to a different issue: #73.

[psq]

Having all files flatten is probably useful as well. Of course, you risk having name clashes so it still needs work. -rr should probably be the default anyway, and use

will comment separately on #73

[mrjoelkemp]

Yes about the default behavior of -r being -rr, I'm not convinced that the flat output is worth supporting another option. For the sake of cleaning up and reducing complexity, I'd like to discard the flat output functionality.

Alongside this is an update to the jsdox() api, so it will be a major bump anyway.

[psq]

I'm fine with that.