Jetpack/SDK/Writing Documentation: Difference between revisions

Jetpack/SDK/Writing Documentation (view source)

26 bytes added , 10 June 2011

canmove, Confirmed users

737

edits

@@ Line 87: / Line 87: @@
 ==== Parameters ====
-You list parameters after the function's description using the "@param" tag. This is followed, on the same line, by the name of the parameter and its data type. The data type is enclosed in braces. Subsequent lines can describe the parameter:
+You list parameters after the function's description using a line which:
+* starts with the "@param" tag
+* is followed, on the same line, by the name of the parameter and its data type. The data type is enclosed in braces.
+Subsequent lines can describe the parameter:
   <api name="alert">