We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Add an example .psc file to show how they should be formatted.
The text was updated successfully, but these errors were encountered:
Ideally, your script should accept any valid formatting.
Sorry, something went wrong.
To my knowledge, it also currently does. E.g:
function int Test(int i) { Test function @param i - An integer @return The supplied parameter } return i endfunction
and
function int Test(int i) {Test function @param i - An integer @return The supplied parameter} return i endfunction
Are both valid formats. However, this should be made clear in an example. See these links for how I use PaPyDoc currently.
Note that GitHub recently changed how sidebar displays titles in the wiki, so it looks a bit funky at the moment.
Ah, I see. So you accept additional formatting commands in the documentation strings? Cool!
No branches or pull requests
Add an example .psc file to show how they should be formatted.
The text was updated successfully, but these errors were encountered: