@@ -228,21 +228,18 @@ made to support a mark-up language.
228
228
229
229
### 5.2. Description
230
230
231
- The Description is OPTIONAL but SHOULD be included when the
232
- "Structural Element", which this DocBlock precedes, contains more operations, or
233
- more complex operations, than can be described in the Summary alone.
231
+ The Description is OPTIONAL but SHOULD be included when the "Structural Element"
232
+ contains more complexity than can be described by the Summary alone.
234
233
235
234
Any application parsing the Description is RECOMMENDED to support the
236
- Markdown mark-up language for this field so that it is possible for the author
237
- to provide formatting and a clear way of representing code examples.
238
-
239
- Common uses for the Description are (amongst others):
240
-
241
- * To provide more detail than the Summary on what this method does.
242
- * To specify of what child elements an input or output array, or object, is
243
- composed.
244
- * To provide a set of common use cases or scenarios in which the
245
- "Structural Element" may be applied.
235
+ Markdown mark-up language, to make it possible for the author to provide
236
+ formatting and a clear way of representing code examples.
237
+
238
+ Common uses for the Description:
239
+ * To provide more detail on what this method does than the Summary can do
240
+ * To specify of what child elements an array / object is composed
241
+ * To provide a set of common use cases or scenarios in which the "Structural
242
+ Element" may be applied
246
243
247
244
### 5.3. Tags
248
245
0 commit comments