diff options
Diffstat (limited to 'en/devices/architecture/hidl/code-style.html')
| -rw-r--r-- | en/devices/architecture/hidl/code-style.html | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/en/devices/architecture/hidl/code-style.html b/en/devices/architecture/hidl/code-style.html index 5f787d71..5f451851 100644 --- a/en/devices/architecture/hidl/code-style.html +++ b/en/devices/architecture/hidl/code-style.html @@ -52,12 +52,14 @@ interface <a href="#interface-names">IFoo</a> { /** * This is a <a href="#comments">multiline docstring</a>. + * * <a href="#return">@return</a> result 0 if successful, nonzero otherwise. */ <a href="#function-declarations">foo() generates (FooStatus result);</a> /** * Restart controller by power cycle. + * * <a href="#param">@param</a> bar callback interface that… * @return result 0 if successful, nonzero otherwise. */ @@ -69,6 +71,7 @@ interface <a href="#interface-names">IFoo</a> { /** * The bar function. + * * <a href="#param">@param</a> <a href="#functions">clientCallback</a> callback after function is called * @param baz related baz object * @param data input data blob @@ -107,7 +110,7 @@ package android.hardware.foo@1.0; <h2 id=naming>Naming conventions</h2> <p>Function names, variable names, and filenames should be descriptive; avoid over-abbreviation. Treat acronyms as words (e.g., use <code>INfc</code> instead -of <code>INFC</code>.</p> +of <code>INFC</code>).</p> <h3 id=dir-structure>Directory structure and file naming</h3> <p>The directory structure should appear as follows:</p> @@ -455,6 +458,7 @@ the package directory).</p> interface IFooController { /** * Opens the controller. + * * @return status HAL_FOO_OK if successful. */ open() generates (FooStatus status); @@ -478,6 +482,7 @@ should be followed by the name of the return value then the docstring.</li> <pre class="prettyprint"> /** * Explain what foo does. + * * @param arg1 explain what arg1 is * @param arg2 explain what arg2 is * @return ret1 explain what ret1 is |