Skip to content
This repository has been archived by the owner on Dec 8, 2021. It is now read-only.

doc: small tweaks to Doxygen documentation #1267

Merged
merged 1 commit into from
Feb 14, 2020
Merged

doc: small tweaks to Doxygen documentation #1267

merged 1 commit into from
Feb 14, 2020

Conversation

coryan
Copy link
Member

@coryan coryan commented Feb 14, 2020

Fixed missing documentation for SessionPoolOptions. Fixed documentation
for some of the *Param classes, they were picking up the documentation
for the group of classes, not their own docs. Made documentation for
*Param consistent. Fixed broken link in RowStreamIterator docs,
apparently Doxygen does not expand links in the brief document.

Fixes #1203


This change is Reviewable

Fixed missing documentation for SessionPoolOptions. Fixed documentation
for some of the `*Param` classes, they were picking up the documentation
for the group of classes, not their own docs. Made documentation for
`*Param` consistent. Fixed broken link in `RowStreamIterator` docs,
apparently Doxygen does not expand links in the brief document.
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Feb 14, 2020
@coryan coryan marked this pull request as ready for review February 14, 2020 16:47
@codecov
Copy link

codecov bot commented Feb 14, 2020

Codecov Report

Merging #1267 into master will decrease coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1267      +/-   ##
==========================================
- Coverage   94.85%   94.85%   -0.01%     
==========================================
  Files         181      181              
  Lines       13794    13792       -2     
==========================================
- Hits        13084    13082       -2     
  Misses        710      710
Impacted Files Coverage Δ
google/cloud/spanner/database_admin_connection.h 100% <ø> (ø) ⬆️
google/cloud/spanner/row.h 90% <ø> (ø) ⬆️
google/cloud/spanner/instance_admin_connection.h 100% <ø> (ø) ⬆️
google/cloud/spanner/session_pool_options.h 100% <ø> (ø) ⬆️
google/cloud/spanner/connection.h 100% <ø> (ø) ⬆️
...loud/spanner/internal/partial_result_set_resume.cc 90.9% <0%> (-4.55%) ⬇️
...ud/spanner/integration_tests/client_stress_test.cc 81.57% <0%> (-1.76%) ⬇️
google/cloud/spanner/internal/spanner_stub.cc 69.56% <0%> (-1.09%) ⬇️
...on_tests/rpc_failure_threshold_integration_test.cc 85.55% <0%> (-0.16%) ⬇️
...anner/integration_tests/client_integration_test.cc 98.47% <0%> (-0.01%) ⬇️
... and 5 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d250c48...58b15c2. Read the comment docs.

@coryan coryan merged commit ee80c16 into googleapis:master Feb 14, 2020
@coryan coryan deleted the documentation-tweaks branch February 14, 2020 17:19
devjgm pushed a commit to devjgm/google-cloud-cpp that referenced this pull request May 7, 2020
…pp-spanner#1267)

Fixed missing documentation for SessionPoolOptions. Fixed documentation
for some of the `*Param` classes, they were picking up the documentation
for the group of classes, not their own docs. Made documentation for
`*Param` consistent. Fixed broken link in `RowStreamIterator` docs,
apparently Doxygen does not expand links in the brief document.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing documentation for SessionPoolOptions
3 participants