C++: fix deprecation comments in BufferWrite

Author: redsun82

cpp/ql/lib/semmle/code/cpp/commons/Printf.qll

@@ -15,30 +15,30 @@ private newtype TBufferWriteEstimationReason =
   TValueFlowAnalysis()
 
 /**
- * A reason for a specific buffer write size estimate
+ * A reason for a specific buffer write size estimate.
  */
 abstract class BufferWriteEstimationReason extends TBufferWriteEstimationReason {
   /**
-   * Returns the name of the concrete class
+   * Returns the name of the concrete class.
    */
   abstract string toString();
 
   /**
-   * Returns a human readable representation of this reason
+   * Returns a human readable representation of this reason.
    */
   abstract string getDescription();
 
   /**
    * Combine estimate reasons. Used to give a reason for the size of a format string
-   * conversion given reasons coming from its individual specifiers
+   * conversion given reasons coming from its individual specifiers.
    */
   abstract BufferWriteEstimationReason combineWith(BufferWriteEstimationReason other);
 }
 
 /**
  * No particular reason given. This is currently used for backward compatibility so that
  * classes derived from BufferWrite and overriding getMaxData\0 still work with the 
- * queries as intended
+ * queries as intended.
  */
 class NoSpecifiedEstimateReason extends BufferWriteEstimationReason, TNoSpecifiedEstimateReason {
   override string toString() { result = "NoSpecifiedEstimateReason" }
@@ -54,7 +54,7 @@ class NoSpecifiedEstimateReason extends BufferWriteEstimationReason, TNoSpecifie
 
 /**
  * The estimation comes from rough bounds just based on the type (e.g.
- * `0 <= x < 2^32` for an unsigned 32 bit integer)
+ * `0 <= x < 2^32` for an unsigned 32 bit integer).
  */
 class TypeBoundsAnalysis extends BufferWriteEstimationReason, TTypeBoundsAnalysis {
   override string toString() { result = "TypeBoundsAnalysis" }

cpp/ql/lib/semmle/code/cpp/security/BufferWrite.qll

@@ -68,13 +68,13 @@ abstract class BufferWrite extends Expr {
   /**
    * Gets an upper bound to the amount of data that's being written (if one
    * can be found).
-   * DEPRECATED: getMaxData\1 should be used and overridden instead
+   * DEPRECATED: `getMaxData/1` should be used and overridden instead.
    */
   deprecated int getMaxData() { none() }
 
   /**
    * Gets an upper bound to the amount of data that's being written (if one
-   * can be found), specifying the reason for the estimation
+   * can be found), specifying the reason for the estimation.
    */
   int getMaxData(BufferWriteEstimationReason reason) {
     reason instanceof NoSpecifiedEstimateReason and result = getMaxData()
@@ -85,7 +85,7 @@ abstract class BufferWrite extends Expr {
    * can be found), except that float to string conversions are assumed to be
    * much smaller (8 bytes) than their true maximum length.  This can be
    * helpful in determining the cause of a buffer overflow issue.
-   * DEPRECATED: getMaxDataLimited\1 should be used and overridden instead
+   * DEPRECATED: `getMaxDataLimited/1` should be used and overridden instead.
    */
   deprecated int getMaxDataLimited() { result = getMaxData() }