-
Notifications
You must be signed in to change notification settings - Fork 93
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
Customise output #31
Comments
I personally prefer this:
So I hope you see my desire to customise the output. |
I would also like to customise the output, although I rather want to have less info, in contrast to @awesomefireduck. |
It would also be nice to be able to customize the tag format. We use Sphinx, which uses the following format:
Also, customizing the "trigger" ( |
We write coffeescript and use codo as doc generator, it would be nice to be able to customize the form of comments. Replace the # Given a obj and a nested keyname, return the value
# Safe from errors
# @param {Object} obj
# @param {String} key
# @return by default is undefined
getVal = (obj, key) ->
unless obj then return obj
keyAttr = key.split('.')
val = obj
for k in keyAttr
if val and val.hasOwnProperty(k)
val = val[k]
else
return undefined
val |
Docblockr already has a few configurations to change the output style and all of them are error-prone, because this configurations have to be considered in many places.
We should think about how to realize these customizations without introducing too many special cases. |
I no longer use Atom, so this isn't an issue for me. |
I still use it with dockblockr and would appreciate this feature. |
#223 is also relevant to this |
I'd really like to customise the default output.
Something like how the extra tags is defined, but including the default tags like description (or perhaps just an on/off switch for the parameters).
And with a reset button to get back the defaults.
I've already pulled the repo and am looking into it, but I've got no experience in JS or CS, only in C++ and a little PHP.
The text was updated successfully, but these errors were encountered: