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

Better JavaDocs for Bastion global configuration #69

Open
KPull opened this issue Jan 6, 2017 · 0 comments
Open

Better JavaDocs for Bastion global configuration #69

KPull opened this issue Jan 6, 2017 · 0 comments
Milestone

Comments

@KPull
Copy link
Member

KPull commented Jan 6, 2017

The methods exposed by Bastion.globals() need improved documentation in their JavaDocs. In particular, JavaDocs are missing for public methods in Configuration and GlobalRequestAttributes.

We need to explain the following:

  • What globals are.
  • What the various attributes mean (headers, query parameters, route parameters, etc.). To avoid duplication, we should link to the JavaDocs in HttpRequest.
  • What the default values for the globals are.
  • That the user should typically clear any globals set, using Bastion.globals().clear(). We should explain this in the method JavaDocs for Bastion.globals().
@KPull KPull changed the title Better JavaDocs Bastion global configuration Better JavaDocs for Bastion global configuration Jan 6, 2017
@KPull KPull added this to the 0.6-BETA milestone Jan 6, 2017
@KPull KPull modified the milestones: 0.6-BETA, 1.0 Mar 31, 2017
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