README.md

marker project repository

Tablet of content

• Installation
• Documentation
• Coding Convention
• Preview

Installation

1. Clone the project

  git clone https://github.com/Youssef-Hammad/marker.git

2. Launch Android Studio
3. Open An Existing Project

OR,

1. Launch Android Studio
2. "Get from Version Control"
3. URL: https://github.com/Youssef-Hammad/marker.git

Documentation

Documentation is automatically generated using Android Studio's javadoc tool integration.

Documentation Generation

To generate documentation, in Android Studio, goto Tools -> Generate JavaDoc... -> OK

Viewing Documentation

Generated documentation will be outputted to ${PROJECT_DIR}/docs

Writing documentation

JavaDoc generates documentation based off of comments starting with a /** and ending with a */

An Example

/**
 * Returns an Image object that can then be painted on the screen. 
 * The url argument must specify an absolute <a href="#{@link}">{@link URL}</a>. The name
 * argument is a specifier that is relative to the url argument. 
 * <p>
 * This method always returns immediately, whether or not the 
 * image exists. When this applet attempts to draw the image on
 * the screen, the data will be loaded. The graphics primitives 
 * that draw the image will incrementally paint on the screen. 
 *
 * @param  url  an absolute URL giving the base location of the image
 * @param  name the location of the image, relative to the url argument
 * @return      the image at the specified URL
 * @see         Image
 */
public Image getImage(URL url, String name) {
  try {
    return getImage(new URL(url, name));
  } catch (MalformedURLException e) {
    return null;
  }
}

Coding Convention

The Java Coding Convention is used.

Preview