From 12acbc2678073c3439b427be0b713b97e2074bfb Mon Sep 17 00:00:00 2001 From: Brent Shaffer Date: Tue, 27 Jun 2017 16:28:28 -0700 Subject: adds PHPDoc @return and @param for getters and setters respectively (#3131) * adds PHPDoc @return and @param for getters and setters respectively * addresses changes in PR review * adds documentation tests * Update php_generator: - Prepend \ to names where required - Remove 
 tags
- Update protobuf field comments

* Updates class files with the protobuf changes

* Addresses review comments

* removes Protobuf Type line from PHP generated classes

* fixes phpdoc test

* adds array types to phpdoc
---
 .../Protobuf/Internal/SourceCodeInfo_Location.php  | 65 +++++++++++-----------
 1 file changed, 31 insertions(+), 34 deletions(-)

(limited to 'php/src/Google/Protobuf/Internal/SourceCodeInfo_Location.php')

diff --git a/php/src/Google/Protobuf/Internal/SourceCodeInfo_Location.php b/php/src/Google/Protobuf/Internal/SourceCodeInfo_Location.php
index cf23e38b..b33013b8 100644
--- a/php/src/Google/Protobuf/Internal/SourceCodeInfo_Location.php
+++ b/php/src/Google/Protobuf/Internal/SourceCodeInfo_Location.php
@@ -12,12 +12,11 @@ use Google\Protobuf\Internal\InputStream;
 use Google\Protobuf\Internal\GPBUtil;
 
 /**
- * Protobuf type google.protobuf.SourceCodeInfo.Location
+ * Generated from protobuf message google.protobuf.SourceCodeInfo.Location
  */
 class SourceCodeInfo_Location extends \Google\Protobuf\Internal\Message
 {
     /**
-     * 
      * Identifies which part of the FileDescriptorProto was defined at this
      * location.
      * Each element is a field number or an index.  They form a path from
@@ -39,27 +38,23 @@ class SourceCodeInfo_Location extends \Google\Protobuf\Internal\Message
      *   [ 4, 3, 2, 7 ]
      * this path refers to the whole field declaration (from the beginning
      * of the label to the terminating semicolon).
-     * 

      *
-     * repeated int32 path = 1 [packed = true];
+     * Generated from protobuf field repeated int32 path = 1 [packed = true];
      */
     private $path;
     private $has_path = false;
     /**
-     * 
      * Always has exactly three or four elements: start line, start column,
      * end line (optional, otherwise assumed same as start line), end column.
      * These are packed into a single field for efficiency.  Note that line
      * and column numbers are zero-based -- typically you will want to add
      * 1 to each before displaying to a user.
-     * 

      *
-     * repeated int32 span = 2 [packed = true];
+     * Generated from protobuf field repeated int32 span = 2 [packed = true];
      */
     private $span;
     private $has_span = false;
     /**
-     * 
      * If this SourceCodeInfo represents a complete declaration, these are any
      * comments appearing before and after the declaration which appear to be
      * attached to the declaration.
@@ -96,19 +91,18 @@ class SourceCodeInfo_Location extends \Google\Protobuf\Internal\Message
      *    * grault. */
      *   optional int32 grault = 6;
      *   // ignored detached comments.
-     * 

      *
-     * optional string leading_comments = 3;
+     * Generated from protobuf field optional string leading_comments = 3;
      */
     private $leading_comments = '';
     private $has_leading_comments = false;
     /**
-     * optional string trailing_comments = 4;
+     * Generated from protobuf field optional string trailing_comments = 4;
      */
     private $trailing_comments = '';
     private $has_trailing_comments = false;
     /**
-     * repeated string leading_detached_comments = 6;
+     * Generated from protobuf field repeated string leading_detached_comments = 6;
      */
     private $leading_detached_comments;
     private $has_leading_detached_comments = false;
@@ -119,7 +113,6 @@ class SourceCodeInfo_Location extends \Google\Protobuf\Internal\Message
     }
 
     /**
-     * 
      * Identifies which part of the FileDescriptorProto was defined at this
      * location.
      * Each element is a field number or an index.  They form a path from
@@ -141,9 +134,9 @@ class SourceCodeInfo_Location extends \Google\Protobuf\Internal\Message
      *   [ 4, 3, 2, 7 ]
      * this path refers to the whole field declaration (from the beginning
      * of the label to the terminating semicolon).
-     * 

      *
-     * repeated int32 path = 1 [packed = true];
+     * Generated from protobuf field repeated int32 path = 1 [packed = true];
+     * @return \Google\Protobuf\Internal\RepeatedField
      */
     public function getPath()
     {
@@ -151,7 +144,6 @@ class SourceCodeInfo_Location extends \Google\Protobuf\Internal\Message
     }
 
     /**
-     * 
      * Identifies which part of the FileDescriptorProto was defined at this
      * location.
      * Each element is a field number or an index.  They form a path from
@@ -173,9 +165,10 @@ class SourceCodeInfo_Location extends \Google\Protobuf\Internal\Message
      *   [ 4, 3, 2, 7 ]
      * this path refers to the whole field declaration (from the beginning
      * of the label to the terminating semicolon).
-     * 

      *
-     * repeated int32 path = 1 [packed = true];
+     * Generated from protobuf field repeated int32 path = 1 [packed = true];
+     * @param int[]|\Google\Protobuf\Internal\RepeatedField $var
+     * @return $this
      */
     public function setPath(&$var)
     {
@@ -192,15 +185,14 @@ class SourceCodeInfo_Location extends \Google\Protobuf\Internal\Message
     }
 
     /**
-     * 
      * Always has exactly three or four elements: start line, start column,
      * end line (optional, otherwise assumed same as start line), end column.
      * These are packed into a single field for efficiency.  Note that line
      * and column numbers are zero-based -- typically you will want to add
      * 1 to each before displaying to a user.
-     * 

      *
-     * repeated int32 span = 2 [packed = true];
+     * Generated from protobuf field repeated int32 span = 2 [packed = true];
+     * @return \Google\Protobuf\Internal\RepeatedField
      */
     public function getSpan()
     {
@@ -208,15 +200,15 @@ class SourceCodeInfo_Location extends \Google\Protobuf\Internal\Message
     }
 
     /**
-     * 
      * Always has exactly three or four elements: start line, start column,
      * end line (optional, otherwise assumed same as start line), end column.
      * These are packed into a single field for efficiency.  Note that line
      * and column numbers are zero-based -- typically you will want to add
      * 1 to each before displaying to a user.
-     * 

      *
-     * repeated int32 span = 2 [packed = true];
+     * Generated from protobuf field repeated int32 span = 2 [packed = true];
+     * @param int[]|\Google\Protobuf\Internal\RepeatedField $var
+     * @return $this
      */
     public function setSpan(&$var)
     {
@@ -233,7 +225,6 @@ class SourceCodeInfo_Location extends \Google\Protobuf\Internal\Message
     }
 
     /**
-     * 
      * If this SourceCodeInfo represents a complete declaration, these are any
      * comments appearing before and after the declaration which appear to be
      * attached to the declaration.
@@ -270,9 +261,9 @@ class SourceCodeInfo_Location extends \Google\Protobuf\Internal\Message
      *    * grault. */
      *   optional int32 grault = 6;
      *   // ignored detached comments.
-     * 

      *
-     * optional string leading_comments = 3;
+     * Generated from protobuf field optional string leading_comments = 3;
+     * @return string
      */
     public function getLeadingComments()
     {
@@ -280,7 +271,6 @@ class SourceCodeInfo_Location extends \Google\Protobuf\Internal\Message
     }
 
     /**
-     * 
      * If this SourceCodeInfo represents a complete declaration, these are any
      * comments appearing before and after the declaration which appear to be
      * attached to the declaration.
@@ -317,9 +307,10 @@ class SourceCodeInfo_Location extends \Google\Protobuf\Internal\Message
      *    * grault. */
      *   optional int32 grault = 6;
      *   // ignored detached comments.
-     * 

      *
-     * optional string leading_comments = 3;
+     * Generated from protobuf field optional string leading_comments = 3;
+     * @param string $var
+     * @return $this
      */
     public function setLeadingComments($var)
     {
@@ -336,7 +327,8 @@ class SourceCodeInfo_Location extends \Google\Protobuf\Internal\Message
     }
 
     /**
-     * optional string trailing_comments = 4;
+     * Generated from protobuf field optional string trailing_comments = 4;
+     * @return string
      */
     public function getTrailingComments()
     {
@@ -344,7 +336,9 @@ class SourceCodeInfo_Location extends \Google\Protobuf\Internal\Message
     }
 
     /**
-     * optional string trailing_comments = 4;
+     * Generated from protobuf field optional string trailing_comments = 4;
+     * @param string $var
+     * @return $this
      */
     public function setTrailingComments($var)
     {
@@ -361,7 +355,8 @@ class SourceCodeInfo_Location extends \Google\Protobuf\Internal\Message
     }
 
     /**
-     * repeated string leading_detached_comments = 6;
+     * Generated from protobuf field repeated string leading_detached_comments = 6;
+     * @return \Google\Protobuf\Internal\RepeatedField
      */
     public function getLeadingDetachedComments()
     {
@@ -369,7 +364,9 @@ class SourceCodeInfo_Location extends \Google\Protobuf\Internal\Message
     }
 
     /**
-     * repeated string leading_detached_comments = 6;
+     * Generated from protobuf field repeated string leading_detached_comments = 6;
+     * @param string[]|\Google\Protobuf\Internal\RepeatedField $var
+     * @return $this
      */
     public function setLeadingDetachedComments(&$var)
     {
-- 
cgit v1.2.3