Library Template

From chipKIT
Jump to: navigation, search
Name of Library
Quick Look
Hardware (External hardware)
Include libname.h


THIS IS A TEMPLATE FILE. COPY THE CONTENTS INTO A NEW PAGE AND EDIT IT FROM THERE. DO NOT EDIT THIS VERSION. 


A brief 1 or 2 line overview of the library goes here - what the library does and what hardware it works with.

Detailed Introduction

This is the library. This is what it does and what you would use it for. It works with this hardware and may require other things as well. Flesh it out nicely.

Wiring

How to wire up the external hardware (if needed) to work with the library. Should be done with reference to the most apt standard chipKIT board for the hardware (UNO32, MAX32, uC32, WF32, etc).

Include pictures - either photographs, or wiring diagrams created with Fritzing.

Introductory Programs

In here show a couple of small programs that work with the hardware as set up in the previous section.

First program

Describe what it does and what results you should see. Mention any caveats and pit-falls that you may need to watch out for and how to sort them out.

Make sure you use pre-formatted
blocks for the code.

That way it all looks right.

Second program

Same as above, if you have one.

Keep going with more programs if the library warrants it.

Full library usage

In here you want to list all (or all the useful) functions in the library. Make it a full reference of everything you can do. Don't specifically include any functions that are inherited from a parent class in the library (such as Stream or Print), instead provide a link to the direct parent class:


Make the function lists into a tree based around headers. Two == for a class name, three for a grouping of items, etc.

Class Name

Constructors

MyClass();

Create a new MyClass object using the default IO pin for the board.

MyClass(uint8_t pin);

Create a new MyClass object specifying the IO pin to use.

Constants

Public Functions

Next Class Name

Constructors

Constants

Public Functions

... etc ...

External Links

List some links to external resources, such as:

... etc ...