<Additional information about your API call. Try to use verbs that match both request type (fetching vs modifying) and plurality (one vs multiple).>
-
URL
<The URL Structure (path only, no root url)>
-
Method:
A complete list of books, articles, blog posts, videos and neat pages that support Data Fundamentals (H), organised by Unit.
If the resource is available online (legally) I have included a link to it. Each entry has symbols following it.
#!/bin/bash | |
if [ $# -eq 0 ]; then | |
echo "Usage: ./pushover <message> [title]" | |
exit | |
fi | |
MESSAGE=$1 | |
TITLE=$2 |
The major important thing is the documentation has to be implementation independent and specification concise. Dependencies where ever necessary are allowed to be specified.
Also it is allows HTML tags to be used in between the documentation comments. Pretty much all tags are self explanatory.
Meta Annotations
@author Ex: @author Jane Doe
@version Ex: @version v1.0-alpha