aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/language.rst
Commit message (Collapse)AuthorAgeFilesLines
* docs: first pass removal of board-specific hardware infobnewbold2014-08-271-2/+2
|
* merge libmaple docs ("leaflabs-docs") into ./docsbnewbold2014-08-271-0/+431
| | | | | | | | | | | | | | | | | | | | | | | | | In the past, libample documentation was forked out of this repository because the documentation had increased in scope. For the librambutan, and the rambutan project in general, we will try to keep documentation closer to the source code, so the librambutan-specific documentation should live here. Other sections of leaflabs-docs will be culled in a following commit. This merge attempts to maintain history by using a subtree strategy. Followed directions at: http://nuclearsquid.com/writings/subtree-merging-and-you/ Full history for files should be accessible using the "--follow" flag to git log, eg: git log --follow docs/source/adc.rst It should be possible to pull patches from leaflabs-docs with: git pull -s subtree leaflabs-docs master ... at least until the docs in this repository diverge significantly.
* Remove reST documentation, attendant updates.Marti Bolivar2011-06-111-449/+0
| | | | | | | | | | | | | | | | | | | | | | The documentation covers topics not specifically relevant to libmaple, so it doesn't make sense for it to be part of the libmaple source distribution. Delete the docs/ tree, and prepare libmaple for use with the new leaflabs-docs repo, which will contain the docs from now on. * README: update to reflect this change * support/doxygen/Doxyfile: This is the old docs/Doxyfile * Makefile: Add a doxygen target * wirish/comm/HardwareSerial.h: fix reference to docs/. The comment informing maintainers that the HardwareSerial interface is documented by hand refers to the docs/ tree, which no longer exists. Update it to refer to the separate leaflabs-docs repository. * support/scripts/copy-to-ide: No longer build the documentation
* Docs: move ASSERT() to its own page.Marti Bolivar2011-06-101-42/+11
| | | | | ASSERT() was previously documented in language.rst. Move it to a new lang/api/assert.rst.
* 0.0.10 Documentation checkpoint.Marti Bolivar2011-04-261-28/+37
| | | | | | | | | | | | | | The vast majority of the Maple-specific values have been pulled out of the higher-level overview pages and replaced with refs into documents under /docs/source/hardware/. Much of the work that's left to be done in this regard is labeled with versioned TODO and FIXME comments. Suggestions from StephenFromNYC and gbulmer were incorporated from this forum thread: http://forums.leaflabs.com/topic.php?id=703
* 0.0.10 documentation checkpoint.Marti Bolivar2011-04-251-33/+44
| | | | | Merging in the standalone refactor docs, etc. The individual libmaple API pages are going to need to get redone.
* Board-specific values; corresponding QA test generalizations.Marti Bolivar2011-03-301-14/+32
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Various board-specific #defines and arrays of pins added. For the changelog (some of this information predates this commit): * wirish/boards.h now declares the following arrays of pin numbers: * boardPWMPins - PWM-capable pins * boardADCPins - ADC-capable pins * boardUsedPins - pins already in use, e.g. BOARD_BUTTON_PIN It also declares a bool boardUsesPin(uint8 pin) function for convenient testing of whether a pin is in use. * wirish/boards/*.h now define: * BOARD_USART1_TX_PIN * BOARD_USART1_RX_PIN * BOARD_USART2_TX_PIN * BOARD_USART2_RX_PIN * BOARD_USART3_TX_PIN * BOARD_USART3_RX_PIN * BOARD_NR_GPIO_PINS (renamed from NR_GPIO_PINS) * BOARD_NR_USARTS (renamed from NR_USARTS) * BOARD_NR_PWM_PINS * BOARD_NR_ADC_PINS * BOARD_NR_USED_PINS * wirish/boards/maple_native.h now defines: * BOARD_UART4_TX_PIN * BOARD_UART4_RX_PIN * BOARD_UART5_TX_PIN * BOARD_UART5_RX_PIN (Unfortunately, wirish/boards/maple_RET6.h cannot, since at least one of the UART4/UART5 pins are used already; this will require layout changes for a wide-release Maple form factor RET6 board). * wirish/boards/*.cpp all include the corresponding array definitions. They all live in flash by default, thanks to the new __FLASH__ macro in wirish/wirish_types.h, which is a synonym for the existing __attr_flash #define in libmaple/libmaple_types.h. The documentation was updated to include this information. It also gained various FIXME/TODO comments related to its generalization across boards. The quality assurance-related examples (examples/qa-slave-shield.cpp and examples/test-session.cpp) now make heavy use of board-specific values to ensure portability.
* shiftOut(), docs fixesMarti Bolivar2011-03-111-4/+5
|
* Cleaned out libmaple.h; this had wide-ranging implications.Marti Bolivar2011-02-271-30/+27
| | | | | | | | | | | | | | | | | | | Many of the #defines in libmaple.h were board-specific, not MCU-specific. Most of these were only used by code under libmaple/usb/. These were moved into usb_config.h, and are clearly marked as being terrible hacks. I'm going to treat the USB stack as a black box that we'll deal with later. Further, instead of having a variety of #defines like "How many USARTS do I have?", we decide that based on the density of the chip. This is determined by testing for STM32_MEDIUM_DENSITY or STM32_HIGH_DENSITY defines. libmaple currently doesn't support low-density chips, so that suffices. The Makefile will set these automatically based on the MCU. Other offending #defines are ERROR_LED_PORT and ERROR_LED_PIN; these were made optional, but they're set in the Makefile as a hack to keep things working.
* Fixed docs bug where we say "long" when we mean "long long"Marti Bolivar2011-02-091-37/+37
|
* Finalized 0.0.9 documentation.Marti Bolivar2010-12-151-118/+115
|
* docs, now with styleHanna Mendes Levitin2010-12-011-2/+8
|
* New documentation content is done. Next step is to theme.Marti Bolivar2010-11-291-2/+14
|
* Finished converting the Arduino docsMarti Bolivar2010-11-291-99/+105
|
* reorganized all the arduino/ docs into a lang/ subdirectory sinceMarti Bolivar2010-11-281-160/+160
| | | | they're properly CC attributed now.
* updated serial bootloader spec; other improvementsMarti Bolivar2010-11-211-268/+201
|
* arduino language reference nearing completion, properly CC-BY-SA 3.0 attributedMarti Bolivar2010-11-171-3/+5
|
* docsMarti Bolivar2010-10-221-6/+4
|
* initial check-in of arduino docs in RST format (converted using wget+pandoc)Marti Bolivar2010-10-201-8/+5
|
* more sphinx docsMarti Bolivar2010-10-111-3/+7
|
* more docsMarti Bolivar2010-10-111-47/+6
|
* docsMarti Bolivar2010-10-111-3/+1
|
* current Maple documentation either rewritten or stubbed out in SphinxMarti Bolivar2010-10-081-49/+80
|
* lots more docsMarti Bolivar2010-10-071-9/+172
|
* language referenceMarti Bolivar2010-10-071-9/+9
|
* language referenceMarti Bolivar2010-10-071-8/+9
|
* language referenceMarti Bolivar2010-10-071-39/+290
|
* some comment stubsMarti Bolivar2010-10-071-0/+86
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-16 13:09:43 +0000