Skip to content

Commit e5097b4

Browse files
committed
Merge pull request #8 from Seldaek/patch
Fix indenting issues
2 parents fc11367 + 27d90d3 commit e5097b4

File tree

1 file changed

+33
-35
lines changed

1 file changed

+33
-35
lines changed

proposed/phpdoc.md

Lines changed: 33 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -129,28 +129,28 @@ interpreted as described in [RFC 2119][RFC2119].
129129
or
130130

131131
```php
132-
/**
133-
* This class acts as an example on where to position a DocBlock.
134-
*/
135-
class Foo
136-
{
137-
/** @type string|null $description Should contain a description */
138-
protected $description = null;
139-
140-
141-
/**
142-
* This method sets a description.
143-
*
144-
* @param string $description A text with a maximum of 80 characters.
145-
*
146-
* @return void
147-
*/
148-
public function setDescription($description)
149-
{
150-
// there should be no docblock here
151-
$this->description = $description;
152-
}
153-
}
132+
/**
133+
* This class acts as an example on where to position a DocBlock.
134+
*/
135+
class Foo
136+
{
137+
/** @type string|null $description Should contain a description */
138+
protected $description = null;
139+
140+
141+
/**
142+
* This method sets a description.
143+
*
144+
* @param string $description A text with a maximum of 80 characters.
145+
*
146+
* @return void
147+
*/
148+
public function setDescription($description)
149+
{
150+
// there should be no docblock here
151+
$this->description = $description;
152+
}
153+
}
154154
```
155155

156156
An example of use that falls beyond the scope of this Standard is to document
@@ -187,9 +187,9 @@ interpreted as described in [RFC 2119][RFC2119].
187187
Multiline example:
188188

189189
```php
190-
/**
191-
* <...>
192-
*/
190+
/**
191+
* <...>
192+
*/
193193
```
194194

195195
* "DocBlock" is a "DocComment" containing a single "PHPDoc" structure and
@@ -508,10 +508,10 @@ Some tags may even feature an "Inline PHPDoc" as shown in the following example.
508508
* @return integer
509509
* }
510510
*/
511-
class MyMagicClass
512-
{
513-
...
514-
}
511+
class MyMagicClass
512+
{
513+
...
514+
}
515515
```
516516

517517
## 6. Inheritance
@@ -690,10 +690,10 @@ Backwards Compatibility.
690690
*
691691
* @return void
692692
*/
693-
function showVersion()
694-
{
695-
<...>
696-
}
693+
function showVersion()
694+
{
695+
<...>
696+
}
697697
```
698698

699699
### 8.2. @author
@@ -1675,7 +1675,6 @@ bi-directional experience and allow for static analysis.
16751675
#### Examples
16761676

16771677
```php
1678-
<?php
16791678
/**
16801679
* @uses \SimpleXMLElement::__construct()
16811680
*/
@@ -1686,7 +1685,6 @@ function initializeXml()
16861685
```
16871686

16881687
```php
1689-
<?php
16901688
/**
16911689
* @uses MyView.php
16921690
*/

0 commit comments

Comments
 (0)