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

Update documentation generation #591

Merged
merged 5 commits into from
Jul 17, 2017

Conversation

michaelbausor
Copy link
Contributor

Explore what this looks like here: https://michaelbausor.github.io/gcloud-php/#/docs/google-cloud/master/core/upload/streamableuploader

Points to note:

  • Classes now list superclasses and interfaces
  • Classes include methods from superclasses and traits inside Google\Cloud
  • Methods defined on external superclasses and traits are NOT included. This is because we cannot be sure they will have a docblock. We may want to consider including them anyway?
  • Added a link the implementing class/trait on relevant methods
  • Included links to build-in types and PSR classes/interfaces

Existing problem that isn't fixed: we don't link correctly when the docs specify a relative class name. See e.g. the param documentation in the existing docs (Duration and Timestamp): https://googlecloudplatform.github.io/google-cloud-php/#/docs/google-cloud/v0.34.1/spanner/database?method=execute
I am not sure what we should do about this - maybe nothing in this PR, but think about a future fix? The easiest thing is to change our docs so that we use FQNs everywhere, but that is ugly for someone reading the code.

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Jul 14, 2017
@jdpedrie
Copy link
Contributor

Existing problem that isn't fixed: we don't link correctly when the docs specify a relative class name.

Generally importing the class will fix this. I tested, and apparently it does not work correctly for nested types (i.e. members of the $options array). Agree that it can be addressed separately.

Copy link
Contributor

@dwsupplee dwsupplee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

@dwsupplee dwsupplee merged commit 71de21d into googleapis:master Jul 17, 2017
@dwsupplee dwsupplee mentioned this pull request Jul 17, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants