search

adafruit / Adafruit_DotStar

GNU General Public License v3.0
97 stars 58 forks source link

actionified, formatted and doxy'd #38

Closed siddacious closed 4 years ago

PaintYourDragon commented 4 years ago

Hey question. Not especially DotStar-related, but this just popped up in my mailbox and there’s been a thing on my mind…

  1. Do we have a guide or any documentation on the entire start-to-finish process of Actionifying, formatting and doxying? Like we had for Travis CI before. I’d really like to understand how to set up the whole process from the start so I’m not dependent on others to wave magic wands and then I come back and some mysterious stuff has happened and I’m either confused, annoyed and/or break it.
  2. If not the full deal, could you point me toward a specific reference on the source code formatting being used, so I can just follow that from the get-go instead of writing things my own way and then inflicting them on you to reformat? (I mean yeah, I could just look at some of the output, but it’s more thorough to have a full standard to refer to.)

Much thanks.

ladyada commented 4 years ago

i havent updated the guide for actions (maybe if @siddacious is feeling industrious he can do so :)

heres my 'actions' checklist

[![Build Status](https://github.com/adafruit/Adafruit_ILI9341/workflows/Arduino%20Library%20CI/badge.svg)](https://github.com/adafruit/Adafruit_ILI9341/actions)

siddacious commented 4 years ago

Ya, I've been meaning to update the guide. I'll see about taking a pass on Monday

siddacious commented 4 years ago

@PaintYourDragon in the meanwhile we're still using doxygen for documentation generation as documented in the guide: https://learn.adafruit.com/the-well-automated-arduino-library/doxygen

For code formatting we're using clang-format as Limor mentioned. It'll to the formatting automagically without modifying the behavior

PaintYourDragon commented 4 years ago

Much appreciated. Thanks! 🐲