From 1e3797ec489d44e76c8dc78c174ef4609464825a Mon Sep 17 00:00:00 2001 From: Mihai Tudor Panu Date: Wed, 3 Jun 2015 15:24:39 -0700 Subject: [PATCH] yuidoc: added custom index file for node documentation and fixed image links Signed-off-by: Mihai Tudor Panu --- CMakeLists.txt | 2 +- .../yuidoc/tmpl/layouts/main.handlebars | 1 + .../yuidoc/tmpl/partials/index.handlebars | 150 ++++++++++++++++++ 3 files changed, 152 insertions(+), 1 deletion(-) create mode 100644 doxy/node/generators/yuidoc/tmpl/partials/index.handlebars diff --git a/CMakeLists.txt b/CMakeLists.txt index 2b8edb75..5d15b073 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -110,7 +110,7 @@ if (BUILDDOC) configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doxy/node/${JSDOC_FILE} ${CMAKE_CURRENT_BINARY_DIR}/${JSDOC_FILE} COPYONLY) endforeach() add_custom_target(jsdoc ALL - COMMAND ${NODE_EXECUTABLE} docgen -m upm -i xml -t ${CMAKE_CURRENT_SOURCE_DIR}/src -g ../../../../docs/images/ + COMMAND ${NODE_EXECUTABLE} docgen -m upm -i xml -t ${CMAKE_CURRENT_SOURCE_DIR}/src -g ../../ COMMAND ${YUIDOC_EXECUTABLE} -C --no-sort --helpers generators/yuidoc/helper.js --themedir generators/yuidoc/tmpl -o html/node jsdoc/yuidoc/upm COMMAND ${NODE_EXECUTABLE} tolower -i html/node DEPENDS doc diff --git a/doxy/node/generators/yuidoc/tmpl/layouts/main.handlebars b/doxy/node/generators/yuidoc/tmpl/layouts/main.handlebars index 7af78e63..c5ef7f0d 100644 --- a/doxy/node/generators/yuidoc/tmpl/layouts/main.handlebars +++ b/doxy/node/generators/yuidoc/tmpl/layouts/main.handlebars @@ -17,6 +17,7 @@

UPM

The UPM API is a high level sensor library for IoT devices using MRAA. See examples here. + Back to index page.

diff --git a/doxy/node/generators/yuidoc/tmpl/partials/index.handlebars b/doxy/node/generators/yuidoc/tmpl/partials/index.handlebars new file mode 100644 index 00000000..e0eacbcd --- /dev/null +++ b/doxy/node/generators/yuidoc/tmpl/partials/index.handlebars @@ -0,0 +1,150 @@ +
+
+

Welcome to UPM Node.JS Documentation!

+ + +

Browse to a module or class using the sidebar to view its API + documentation.

+ +

UPM is a high level repository for sensors that use libmraa. Each + sensor links to libmraa and are not meant to be interlinked although + some groups of sensors may be. Each sensor contains a header which + allows to interface with it. Typically a sensor is represented as a + class and instantiated.

+ +

The constructor is expected to initialise the sensor and + parameters may be used to provide identification/pin location on the + board.

+ +

Typically an update() function will be called in order to get new + data from the sensor in order to reduce load when doing multiple + reads to sensor data.

+
+

Building + UPM*

+ + +

For building UPM, please follow this + link.

+ +
+
+

Making + your own + UPM Module*

+ + +

This + link + has more information on making a new UPM module.

+ +

There is also an example available for max31855 + sensor.

+ +
+
+

Naming + Conventions and + Rules for + New UPM + Contributions*

+ + +

Before you begin development, please take a look at our naming + conventions.

+ + +

Also, please read the guidelines for contributions to + UPM.

+ + +

Don’t forget to check the documentation + section.

+ +
+ +

Note

+
    +
  • Make sure you add yourself as an author on every new + code file submitted.
    • +
  • If you are providing a fix with significant changes, + feel free to add yourself as a contributor.
    • +
  • Signing-off your commits is mandatory.
    • +
+
+
+
+

API Documentation

+ + +

+ + +

+
+
+

Version + Changelog*

+ + +

For our Version Changelog, please see + here.

+ +
+
+

Known + Limitations*

+ + +

For the List of Known Limitations, please see + here.

+ +
+
+

Keyboard + Shortcuts*

+ +
    +
  • + +

    Press s to focus the API search box.

    • +
  • + +

    Use Up and Down to select classes, + modules, and search results.

    • +
  • + +

    With the API search box or sidebar focused, use ⌘-Left + or ⌘-Right to switch + sidebar tabs.

    • +
  • + +

    With the API search box or sidebar focused, use Ctrl+Left + and Ctrl+Right to switch sidebar tabs.

    • +
+
+