docs: overhauled documentation#1096
docs: overhauled documentation#1096stephenplusplus merged 1 commit intogoogleapis:masterfrom callmehiphop:common-docs
Conversation
What is the improper use? |
I think |
|
@mixin: A mixin provides functionality that is intended to be added to other objects. If desired, you can use the @mixin tag to indicate that an object is a mixin. You can then add the @mixes tag to objects that use the mixin. JSDocs is pretty wild. What's a better way to describe (and document) the connection? |
Still looking into that.. worst case scenario I'll just make |
|
Cool cool. |
|
But if I can make it work without it, one thing I'd strive to do is kill off all the empty variables.. |
|
Yes, please! |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
scripts/docs.js
Outdated
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
|
@callmehiphop Can you point me to where your build waits "for new doc app to be merged into gcloud-common"? I saw that got checked off but can't find the commit. I'm currently working on our gcloud-ruby json output using the docs app & assets that I manually copied from your gh-pages... But of course I need to automate. |
|
@quartzmo I was just waiting for the main app to get merged into gcloud-common, which it did yesterday via https://github.com/GoogleCloudPlatform/gcloud-common/pull/34. We have a hook that will generate JSON, etc. and didn't want to merge these changes in until all the other parts were good to go. |
docs: overhauled documentation
Co-authored-by: Summer Ji <summerji@google.com>
) Source-Link: googleapis/synthtool@cd78529 Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-nodejs:latest@sha256:ddb19a6df6c1fa081bc99fb29658f306dd64668bc26f75d1353b28296f3a78e6
Big Update Ahead!
Notable changes:
@exampletags to follow JSDoc standardTODOS
@linkcodetags in favor for custom type syntax ({module:service/object#method})@mixestag for ACL and IAM properties@stephenplusplus let me know if there's anything I can do to make this easier to go through.. :)