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.

Sign up for GitHub

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

Jump to bottom

feat(docs): add namespace (formatted for docfx) #6332

Merged
merged 1 commit into from
Jun 9, 2023
Merged

feat(docs): add namespace (formatted for docfx) #6332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions dev/src/DocFx/Page/Page.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ private function getClassItem(): array
'summary' => $this->classNode->getContent(),
'status' => $this->classNode->getStatus(),
'type' => 'class',
'namespace' => implode(' \ ', explode('\\', ltrim($this->classNode->getNamespace(), '\\'))),
'langs' => ['php'],
'implements' => $this->classNode->getImplements(),
]);
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/NewClient/V1.Client.SecretManagerServiceClient.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

This class is currently experimental and may be subject to changes.
type: class
namespace: 'Google \ Cloud \ SecretManager \ V1 \ Client'
Copy link

Choose a reason for hiding this comment

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

Based on the example from googleapis/doc-pipeline#478, I think the namespace should have the SecretManagerServiceClient (maybe in href) added at the end - do you want to exclude the current class?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I like the idea visually (as long as the href is wrapping it) but in this case, since this falls directly under the header Namespace, I think it would be confusing unless there's a way to make it VERY obvious. For instance, if we greyed it out and put it in italics.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We also found that we can’t add HTML here so we are going to skip this for now (and hopefully add it later)

langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.AddProductToProductSetRequest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.AddProductToProductSetRequest</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.AnnotateFileRequest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.AnnotateFileRequest</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.AnnotateFileResponse.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.AnnotateFileResponse</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.AnnotateImageRequest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.AnnotateImageRequest</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.AnnotateImageResponse.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.AnnotateImageResponse</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.AsyncAnnotateFileRequest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.AsyncAnnotateFileRequest</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.AsyncAnnotateFileResponse.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.AsyncAnnotateFileResponse</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateFilesRequest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.AsyncBatchAnnotateFilesRequest</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateFilesResponse.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.AsyncBatchAnnotateFilesResponse</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateImagesRequest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.AsyncBatchAnnotateImagesRequest</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.AsyncBatchAnnotateImagesResponse.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.AsyncBatchAnnotateImagesResponse</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateFilesRequest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.BatchAnnotateFilesRequest</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateFilesResponse.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.BatchAnnotateFilesResponse</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateImagesRequest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.BatchAnnotateImagesRequest</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.BatchAnnotateImagesResponse.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.BatchAnnotateImagesResponse</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.BatchOperationMetadata.State.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Protobuf type <code>google.cloud.vision.v1.BatchOperationMetadata.State</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1 \ BatchOperationMetadata'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.BatchOperationMetadata.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.BatchOperationMetadata</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.Block.BlockType.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Protobuf type <code>google.cloud.vision.v1.Block.BlockType</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1 \ Block'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.Block.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.Block</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.BoundingPoly.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.BoundingPoly</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.ColorInfo.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.ColorInfo</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.CreateProductRequest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.CreateProductRequest</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.CreateProductSetRequest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.CreateProductSetRequest</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.CreateReferenceImageRequest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.CreateReferenceImageRequest</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.CropHint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.CropHint</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.CropHintsAnnotation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.CropHintsAnnotation</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.CropHintsParams.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.CropHintsParams</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.DeleteProductRequest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.DeleteProductRequest</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.DeleteProductSetRequest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.DeleteProductSetRequest</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.DeleteReferenceImageRequest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.DeleteReferenceImageRequest</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.DominantColorsAnnotation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.DominantColorsAnnotation</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.EntityAnnotation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.EntityAnnotation</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.FaceAnnotation.Landmark.Type.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ items:

Protobuf type <code>google.cloud.vision.v1.FaceAnnotation.Landmark.Type</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1 \ FaceAnnotation \ Landmark'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.FaceAnnotation.Landmark.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.FaceAnnotation.Landmark</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1 \ FaceAnnotation'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.FaceAnnotation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.FaceAnnotation</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.Feature.Type.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Protobuf type <code>google.cloud.vision.v1.Feature.Type</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1 \ Feature'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.Feature.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.Feature</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.GcsDestination.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.GcsDestination</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.GcsSource.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.GcsSource</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.GetProductRequest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.GetProductRequest</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.GetProductSetRequest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.GetProductSetRequest</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.GetReferenceImageRequest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.GetReferenceImageRequest</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.Image.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.Image</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.ImageAnnotationContext.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.ImageAnnotationContext</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.ImageAnnotatorClient.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ items:
}
```
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.ImageContext.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.ImageContext</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.ImageProperties.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.ImageProperties</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
1 change: 1 addition & 0 deletions dev/tests/fixtures/docfx/Vision/V1.ImageSource.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ items:

Generated from protobuf message <code>google.cloud.vision.v1.ImageSource</code>
type: class
namespace: 'Google \ Cloud \ Vision \ V1'
langs:
- php
children:
Expand Down
Loading