Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix indenting issues #8

Merged
merged 1 commit into from
Aug 13, 2013
Merged

Fix indenting issues #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 33 additions & 35 deletions proposed/phpdoc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,28 +129,28 @@ interpreted as described in [RFC 2119][RFC2119].
or

```php
/**
* This class acts as an example on where to position a DocBlock.
*/
class Foo
{
/** @type string|null $description Should contain a description */
protected $description = null;


/**
* This method sets a description.
*
* @param string $description A text with a maximum of 80 characters.
*
* @return void
*/
public function setDescription($description)
{
// there should be no docblock here
$this->description = $description;
}
}
/**
* This class acts as an example on where to position a DocBlock.
*/
class Foo
{
/** @type string|null $description Should contain a description */
protected $description = null;


/**
* This method sets a description.
*
* @param string $description A text with a maximum of 80 characters.
*
* @return void
*/
public function setDescription($description)
{
// there should be no docblock here
$this->description = $description;
}
}
```

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

```php
/**
* <...>
*/
/**
* <...>
*/
```

* "DocBlock" is a "DocComment" containing a single "PHPDoc" structure and
Expand Down Expand Up @@ -508,10 +508,10 @@ Some tags may even feature an "Inline PHPDoc" as shown in the following example.
* @return integer
* }
*/
class MyMagicClass
{
...
}
class MyMagicClass
{
...
}
```

## 6. Inheritance
Expand Down Expand Up @@ -690,10 +690,10 @@ Backwards Compatibility.
*
* @return void
*/
function showVersion()
{
<...>
}
function showVersion()
{
<...>
}
```

### 8.2. @author
Expand Down Expand Up @@ -1675,7 +1675,6 @@ bi-directional experience and allow for static analysis.
#### Examples

```php
<?php
/**
* @uses \SimpleXMLElement::__construct()
*/
Expand All @@ -1686,7 +1685,6 @@ function initializeXml()
```

```php
<?php
/**
* @uses MyView.php
*/
Expand Down