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

Schema and private properties #31

Open
bredele opened this issue Dec 13, 2017 · 0 comments
Open

Schema and private properties #31

bredele opened this issue Dec 13, 2017 · 0 comments

Comments

@bredele
Copy link
Contributor

bredele commented Dec 13, 2017

Documentation can be generated from the schema and sometimes schema can be useful for internal machinery. Having an attribute private could tell the generator to leave an attribute out of the doc.

        test: {
          private: true,
          description: `
            This is some description to make sure this parameters can not be overriden.
          `,
          transform() {
            return null
          }
        }
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant