ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Header Creator

by Harryman ST2/ST3

This script is aimed to make writing arduino libraries less painful by creating the header file and keywords.txt file automatically from your library.

Details

  • 2013.11.25.23.54.15
  • github.​com
  • github.​com
  • 6 years ago
  • 3 hours ago
  • 6 years ago

Installs

  • Total 2K
  • Win 918
  • OS X 341
  • Linux 368
Oct 18 Oct 17 Oct 16 Oct 15 Oct 14 Oct 13 Oct 12 Oct 11 Oct 10 Oct 9 Oct 8 Oct 7 Oct 6 Oct 5 Oct 4 Oct 3 Oct 2 Oct 1 Sep 30 Sep 29 Sep 28 Sep 27 Sep 26 Sep 25 Sep 24 Sep 23 Sep 22 Sep 21 Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11 Sep 10 Sep 9 Sep 8 Sep 7 Sep 6 Sep 5 Sep 4
Windows 0 0 0 0 0 0 1 1 0 0 1 0 0 1 1 0 1 0 0 0 0 1 0 0 0 2 0 0 1 0 2 0 0 1 0 0 0 0 1 0 0 1 0 0 1
OS X 0 0 0 0 0 0 1 1 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 1 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

Arduino-header-keyword-creator

The purpose of this script to make writing arduino libraries less painful by creating the header file and keywords.txt file automatically from your library. It will pull Top comments, includes, functions along with their adjacent comments, and variables with types*(see instructions)

This is the first python script and Sublime Text plugin I've made so the code is a bit of a mess.

This is available through Package Control

I haven't tested it on ST3 but it does work on ST2 for windows. I'm pretty sure this will bug out and not work Linux because of different path separators.

Instructions

  • .cpp file must use explicit { }
  • Private functions & variables must start with and underscore(_) i.e. _privar
  • the variable type are pulled from the exsisting .h file
  • just to be on the safe side you should make copy of your exsisting header file, just incase
  • if there is no exsisting .h file you will have to manually enter the datatype
  • Copies comments directly from the top
  • Copies comments from driectly above or on the same line as the function or above it
  • creates keywords.txt with all of the public functions and libname
  • All references in the library should look like the file name YOURLIB.cpp YOURLIB will be used to parse the file and find functions etc. include your YOURLIB.h before any other includes
  • Use library https://github.com/Harryman/simple-buttons-arduino as an example of what the formatting looks like if you are still unsure how it works

If you find utility or vaule in it please return the favor via bitcoin: 17E66DJ5hEx6wSFxnSvYM7jgXY2PYBVrth

Or if you just want to donate to my beer fund: 151sgJ4z2tNGzVFJHGyBAd8H4F4RT62ebQ