https://github.com/bengtmartensson/keywordstxtgenerator

Automatically generates an Arduino project keywords.txt
https://github.com/bengtmartensson/keywordstxtgenerator

arduino doxygen keywords xslt

Last synced: about 1 month ago
JSON representation

Automatically generates an Arduino project keywords.txt

• Host: GitHub
• URL: https://github.com/bengtmartensson/keywordstxtgenerator
• Owner: bengtmartensson
• License: other
• Created: 2017-08-21T12:54:17.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-05-11T14:28:22.000Z (over 6 years ago)
• Last Synced: 2024-10-22T11:23:28.568Z (3 months ago)
• Topics: arduino, doxygen, keywords, xslt
• Language: XSLT
• Size: 6.84 KB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# KeywordsTxtGenerator: generate `keywords.txt` for Arduino projects

This simple tool automatically generates an Arduino project

[keywords.txt](https://spencer.bliven.us/index.php/2012/01/18/arduino-ide-keywords/)

from the corresponding project sources. For this, it uses [Doxygen](http://www.doxygen.org) and XSLT (version 1.0).

The main component of the current "project" is the XSLT transformation `doxygen2keywords.xsl`,

which transforms a Doxygen xml file to the `keywords.txt` file. The enclosed Doxygen minimalist configuration file `keywords_txt_generator.doxy`

can be used. But it can also be generated by most Doxygen configuration, just be sure to define `GENERATE_XML = YES` therein.

For convenience, a Makefile is also supplied. There are two way to use this:

1. Either unpack all files in the Arduino project directory, and just type `make` there.

2. Unpack anywhere, and type `make `_Arduino-project-dir_`/keywords.txt`,

(where _Arduino-project-dir_ denotes the Arduino project).

This project is in the public domain.