lyrl

JAVADOC CHEATSHEET

Introduction

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

Project Title

One Paragraph of project description goes here

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Title

<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:

	# installation
	sudo apt install fio

	# run benchmark
	fio --randrepeat=1 --ioengine=libaio --direct=1 --gtod_reduce=1 \
	--name=test --filename=/tmp/test --bs=4k --iodepth=64 --size=4G \
	--readwrite=randrw --rwmixread=75

	# delete test file
	rm /tmp/test

	#!/bin/bash

	if [ $# -eq 0 ]; then
	echo "Usage: ./pushover <message> [title]"
	exit
	fi

	MESSAGE=$1
	TITLE=$2