You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@geode.apache.org by GitBox <gi...@apache.org> on 2020/10/02 17:50:52 UTC
[GitHub] [geode-native] moleske opened a new pull request #666: GEODE-8571: Enforce documentation errors
moleske opened a new pull request #666:
URL: https://github.com/apache/geode-native/pull/666
Authored-by: M. Oleske <mi...@oleske.engineer>
Ran on [Windows](https://github.com/moleske/geode-native/actions/runs/280909801) (Visual Studio 2017 and some on Visual Studio 2019) and [Ubuntu](https://github.com/moleske/geode-native/actions/runs/280909802) (16.04 and 18.04)
This does not fix content or incorrectness in the docs, I need some feedback/help on that. I also made some questionable decisions, see if you can find them! Since this is going to be mostly grammar/spell check/making sure they're not lying, it is probably easier just to push your suggestions directly if you have access (box is checked for allow edits by maintainers)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode-native] pdxcodemonkey merged pull request #666: GEODE-8571: Enforce documentation errors
Posted by GitBox <gi...@apache.org>.
pdxcodemonkey merged pull request #666:
URL: https://github.com/apache/geode-native/pull/666
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode-native] moleske commented on a change in pull request #666: GEODE-8571: Enforce documentation errors
Posted by GitBox <gi...@apache.org>.
moleske commented on a change in pull request #666:
URL: https://github.com/apache/geode-native/pull/666#discussion_r499879025
##########
File path: cppcache/include/geode/internal/chrono/duration.hpp
##########
@@ -145,8 +145,8 @@ inline
/**
* Converts std::chrono::duration to std::string.
*
- * @tparam Rep
- * @tparam Period
+ * @tparam Rep the something that reps
+ * @tparam Period the something else that periods
Review comment:
Ended up just removing it since it is internal . Let me know what you think @karensmolermiller
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode-native] moleske commented on a change in pull request #666: GEODE-8571: Enforce documentation errors
Posted by GitBox <gi...@apache.org>.
moleske commented on a change in pull request #666:
URL: https://github.com/apache/geode-native/pull/666#discussion_r499094966
##########
File path: cppcache/include/geode/internal/chrono/duration.hpp
##########
@@ -145,8 +145,8 @@ inline
/**
* Converts std::chrono::duration to std::string.
*
- * @tparam Rep
- * @tparam Period
+ * @tparam Rep the something that reps
+ * @tparam Period the something else that periods
Review comment:
I wanted to come back and write something meaningful, but never did. If no one has suggestions I'll just delete the documentation here
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode-native] karensmolermiller commented on a change in pull request #666: GEODE-8571: Enforce documentation errors
Posted by GitBox <gi...@apache.org>.
karensmolermiller commented on a change in pull request #666:
URL: https://github.com/apache/geode-native/pull/666#discussion_r499092657
##########
File path: cppcache/include/geode/internal/chrono/duration.hpp
##########
@@ -145,8 +145,8 @@ inline
/**
* Converts std::chrono::duration to std::string.
*
- * @tparam Rep
- * @tparam Period
+ * @tparam Rep the something that reps
+ * @tparam Period the something else that periods
Review comment:
Almost a worse definition than not having one at all?
##########
File path: cppcache/src/statistics/StatArchiveWriter.hpp
##########
@@ -232,9 +232,9 @@ class APACHE_GEODE_EXPORT StatArchiveWriter {
/**
* Opens the statArchiver by opening the file provided as a parameter.
- * @param std::string filename.
+ * @param filename string representation of the file
Review comment:
Better as
* @param filename string representation of the file name
##########
File path: cppcache/src/CqService.hpp
##########
@@ -211,8 +211,10 @@ class APACHE_GEODE_EXPORT CqService
* Invokes the CqListeners for the given CQs.
* @param cqs list of cqs with the cq operation from the Server.
* @param messageType base operation
- * @param key
- * @param value
+ * @param key to invoke listeners with
+ * @param value to invoke listeners with
+ * @param deltaValue to invoke listeners with
Review comment:
I don't see these parameters in the function header.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [geode-native] moleske commented on a change in pull request #666: GEODE-8571: Enforce documentation errors
Posted by GitBox <gi...@apache.org>.
moleske commented on a change in pull request #666:
URL: https://github.com/apache/geode-native/pull/666#discussion_r499094822
##########
File path: cppcache/src/CqService.hpp
##########
@@ -211,8 +211,10 @@ class APACHE_GEODE_EXPORT CqService
* Invokes the CqListeners for the given CQs.
* @param cqs list of cqs with the cq operation from the Server.
* @param messageType base operation
- * @param key
- * @param value
+ * @param key to invoke listeners with
+ * @param value to invoke listeners with
+ * @param deltaValue to invoke listeners with
Review comment:
`key`, `value`, `deltaValue` are on lines 221-223 right below
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org