Skip to content
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

Add example .psc file #3

Open
MrOctopus opened this issue Dec 27, 2020 · 3 comments
Open

Add example .psc file #3

MrOctopus opened this issue Dec 27, 2020 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@MrOctopus
Copy link
Owner

Add an example .psc file to show how they should be formatted.

@MrOctopus MrOctopus added the documentation Improvements or additions to documentation label Dec 27, 2020
@BellCubeDev
Copy link

Ideally, your script should accept any valid formatting.

@MrOctopus
Copy link
Owner Author

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.

@BellCubeDev
Copy link

Ah, I see. So you accept additional formatting commands in the documentation strings? Cool!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants