di0ib/keybrd
Archived
1
0
Fork 0
Code Releases Activity

document

Browse Source
This commit is contained in:
wolfv6 2016-06-03 21:57:24 -06:00
parent 7b9c87b742
commit 589514dc3d
2 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/keybrd_library_developer_guide.md
View File

@ -8,7 +8,7 @@ The most common reason for new classes are:
## Who this guide is for ## Who this guide is for
This guide is for the maintainers and developers of the keybrd library and it's extensions. This guide is for the maintainers and developers of the keybrd library and it's extensions.
It is assumed the reader is familiar with C++ language including pointers, objects, classes, static class variables, composition, inheritance, polymorphism, and enum. It is assumed the reader is familiar with C++ language including pointers, objects, classes, static class variables, aggregation, inheritance, polymorphism, and enum.
Some classes use bit manipulation. Some classes use bit manipulation.
## Class inheritance diagrams ## Class inheritance diagrams
@ -148,7 +148,6 @@ Following the style guide makes it easier for the next programmer to understand
``` ```
* In constructor's initialization list, use same names for fields and constructor parameters. * In constructor's initialization list, use same names for fields and constructor parameters.
* Do not use new or malloc (making memory leaks impossible). * Do not use new or malloc (making memory leaks impossible).
* If class has any non-[POD](http://en.wikipedia.org/wiki/Plain_old_data_structure) data members, [do not inline constructors and destructors](http://www.chromium.org/developers/coding-style/cpp-dos-and-donts).
* Document class interface in .h file, above the class declaration. * Document class interface in .h file, above the class declaration.
* Code should be self-documenting. The only comments should be things that may need clarification. A simple function with a good name needs no comment. * Code should be self-documenting. The only comments should be things that may need clarification. A simple function with a good name needs no comment.
* Code is automatically formated before being pushed to the keybrd repository. * Code is automatically formated before being pushed to the keybrd repository.

2
doc/keybrd_library_user_guide.md
View File

@ -17,7 +17,7 @@ This guide is for anyone who wants to use the keybrd library to develop keyboard
A reader with programming experience, but no C++ experience, would understand the tutorials well enough to modify existing keybrd sketches. A reader with programming experience, but no C++ experience, would understand the tutorials well enough to modify existing keybrd sketches.
An experienced C++ programmer would be able to write original sketches and classes. An experienced C++ programmer would be able to write original sketches and classes.
The library is written in the C++ language and uses pointers, objects, classes, static class variables, composition, inheritance, and enum. The library is written in the C++ language and uses pointers, objects, classes, static class variables, aggregation, inheritance, and enum.
## Microcontroller board requirements ## Microcontroller board requirements
The keybrd library works with Teensy and Arduino boards. The keybrd library works with Teensy and Arduino boards.