Skip to content

Commit

Permalink
Fix wording of documentation section.
Browse files Browse the repository at this point in the history
  • Loading branch information
xian committed Mar 9, 2018
1 parent ac4a36c commit 2ea3f4f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion contributing.md
Expand Up @@ -58,7 +58,7 @@ Robolectric is a unit testing framework and it is important that Robolectric its
Robolectric uses [Markdown Doclet](https://github.com/Abnaxos/markdown-doclet), so write javadoc
using [markdown](http://daringfireball.net/projects/markdown/), with javadoc tag extensions.

On [developer.android.com](https://developer.android.com/reference/packages.html), class-level and method-level javadoc on shadow classes is inserted into the javadoc for the class it shadows, and identified as Robolectric-related testing notes. Javadoc on visible, non-`@Implementation` methods on shadow classes are displayed in a new 'Testing APIs' section of the page.
For developers with the [Robolectric Chrome Extension](https://chrome.google.com/webstore/detail/robolectric/pjepcinimnfnaoopahdkpkefnefdkdgh) installed, javadoc on Robolectric shadow classes and methods are inserted into [developer.android.com](https://developer.android.com/reference/packages.html) sections for the classes and methods they shadow, and identified as Robolectric-related testing notes. Javadoc on visible, non-`@Implementation` methods on shadow classes are displayed in a new 'Testing APIs' section for the shadowed class.

There are special rules for javadoc on shadow classes to support the [Robolectric Chrome Extension](https://chrome.google.com/webstore/detail/robolectric/pjepcinimnfnaoopahdkpkefnefdkdgh):
* All `@Implementation` methods whose behavior varies from the standard Android behavior MUST have Javadoc describing the difference. Use `@see` or `{@link}` to indicate if the method's behavior can be changed or inspected by calling testing API methods. If the method's behavior is identical to the normal framework behavior, no javadoc is necessary.
Expand Down

0 comments on commit 2ea3f4f

Please sign in to comment.