Permalink
Show file tree
Hide file tree
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
DocumentationStyleBear: Add blankline support
DocumentationStyleBear now checks for blankline before and after the docstring and fixes them. Related to coala/coala#4200
- Loading branch information
Showing
11 changed files
with
130 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
class HelloWorld { | ||
|
||
/** | ||
*Java docstyle test. | ||
*There's no official standard for how paddings are in java. | ||
*Hence, in this case paddings are preserved as original. | ||
* | ||
*@param name the name to which to say hello | ||
*@raises IOException throws IOException | ||
*@return the concatenated string | ||
*/ | ||
public String sayHello(String name) throws IOException { | ||
return "Hello, " + name; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
class HelloWorld { | ||
|
||
/** | ||
*Java docstyle test. | ||
*There's no official standard for how paddings are in java. | ||
*Hence, in this case paddings are preserved as original. | ||
* | ||
*@param name | ||
* the name to which to say hello | ||
*@raises IOException | ||
* throws IOException | ||
*@return | ||
* the concatenated string | ||
*/ | ||
public String sayHello(String name) throws IOException { | ||
return "Hello, " + name; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -17,7 +17,7 @@ def docstring_singleliner(): | ||
""" | ||
This is singleliner docstring. | ||
""" | ||
|
||
return None | ||
|
||
def docstring_inline(): | ||
""" | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters