Improve comment description formatting in JSDoc (#54)

swaggest · Dec 18, 2023 · 395ef94 · 395ef94
1 parent 57f9213
commit 395ef94
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 16 deletions.
diff --git a/composer.lock b/composer.lock
diff --git a/src/JSDoc/TypeBuilder.php b/src/JSDoc/TypeBuilder.php
@@ -288,7 +288,14 @@ private function makeObjectTypeDef(Schema $schema, $path)
 
     private function description(Schema $schema)
     {
-        $res = str_replace("\n", " ", $schema->title . $schema->description);
+        $res = str_replace("\n", " ", trim($schema->title));
+        if (trim($schema->description)) {
+            if ($res) {
+                $res .= ". ";
+            }
+
+            $res .= str_replace("\n", " ", trim($schema->description));
+        }
         if ($res) {
             return ' - ' . rtrim($res, '.') . '.';
         }

diff --git a/tests/src/PHPUnit/JSDoc/JSDocTest.php b/tests/src/PHPUnit/JSDoc/JSDocTest.php
@@ -16,7 +16,7 @@ public function testJsonSchema()
         "Person": {
             "type": "object",
             "properties": {
-                "name": {"type": "string", "description": "Person name."},
+                "name": {"type": "string", "title":"     Name    ", "description": "The name of the person."},
                 "age": {"type": "integer"},
                 "isMale": {"type": "boolean"},
                 "partner": {"$ref": "#/definitions/Person"},
@@ -37,7 +37,7 @@ public function testJsonSchema()
 /**
  * @typedef Person
  * @type {Object}
- * @property {String} name - Person name.
+ * @property {String} name - Name. The name of the person.
  * @property {Number} age
  * @property {Boolean} isMale
  * @property {Person} partner