New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Support multiple files with the same name. #236
Conversation
Previously, if two or more files had the same base filename only one would be documented. The others would be overwritten. This patch replicates the structure of the source tree in the document output tree to allow source files with the same name but different paths.
This should be behind a command line switch, because some people desire having a flat doc tree, and this would be a breaking change for those people. |
That doesn't sound very quick-and-dirty now, does it? Instead, it would be nice to leave things flat, but prefix duplicate file names with their relative path as a qualification. |
Sorry @jashkenas, just concerned about users who currently expect a flat structure |
Hi, I just ran into this problem too. I'm new to Docco and I found it overwrites files with the same name today. Example: % grunt docs|grep articles Using: % docco --version I want to use Docco as other options are all way more complicated than I really need. I guess moving forward I'll need to re-factor files name in the above example to something like: app/controllers/articlesController.js I guess main benefit is all articles docs will group together in the flat structure Docco output folder. I was assuming they'd not overwrite but that's fine. Thanks. |
I ran into the same problem. |
@karlspalding could you please rebase this, then I'll take another look. Thanks 😄 |
+1 I would very much like support for this. |
👍 Is this going to be in the 0.6.4 release? |
- Work around docco issue #236 - needs support for conflicting file names @see jashkenas/docco#236 - simple rename of all the service files so they can co-exist in a flat directory. Signed-off-by: Yan-Fa Li <yanfali@gmail.com>
This is much needed. Large project have too many conflicting names to have only names in a flat directory structure. |
I got tired of waiting and created my own fork of grunt-docco, so if you are using grunt |
+1 |
1 similar comment
+1 |
Unfortunately we can't merge this until @karlspalding rebases against master. Alternatively, anyone else is welcome to take @karlspalding's implementation and update it in a new PR 😄. |
- taken from the source of @karlspalding on jashkenas#236
- taken from the source of @karlspalding on jashkenas#236 - fixes jashkenas#303 - closes jashkenas#236
@keithamus I took a stab on getting this PR's commit and rebasing it with the current master. Tested in my local and it works #336. Let me know if I need to change the commit attribution, since afterall it was @karlspalding 's original PR. |
any update on this one? seems to me very important given all the "index.js" modern front end projects have |
+1 |
Fixes #223.
Previously, if two or more files had the same base filename
only one would be documented. The others would be overwritten.
This patch replicates the structure of the source tree in the
document output tree to allow source files with the same
name but different paths.