aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang
Commit message (Collapse)AuthorAgeFilesLines
* merge libmaple docs ("leaflabs-docs") into ./docsbnewbold2014-08-27111-0/+8111
| | | | | | | | | | | | | | | | | | | | | | | | | 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-11111-7997/+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-0/+30
| | | | | ASSERT() was previously documented in language.rst. Move it to a new lang/api/assert.rst.
* Docs: Use "BOARD_LED_PIN" instead of "13".Marti Bolivar2011-06-108-41/+36
| | | | | | Fix examples where pin 13 was used explicitly instead of BOARD_LED_PIN. Also change an AVR-specific example in docs/lang/cpp/booleanvariables.rst to Maple conventions.
* Docs: Tweak disabling JTAG debugging information.Marti Bolivar2011-05-281-2/+4
|
* Docs: Improve analogwrite.rst.Marti Bolivar2011-05-281-10/+15
| | | | | | Make the note warning against its usage more direct. Add a blurb introducing its purpose and links in See Also to related board-specific values.
* Docs: Updating pinmode.rstMarti Bolivar2011-05-271-22/+25
| | | | Convert to board-specific values; make the language friendlier.
* Fix millis() example.Marti Bolivar2011-05-261-1/+1
|
* Docs: board-values.rst touchup.Marti Bolivar2011-05-261-3/+0
|
* Docs: Move toggleLED() and waitForButtonPress() examples.Marti Bolivar2011-05-263-32/+60
| | | | | These two examples from board-values.rst really belong in the documentation for the functions they reference.
* Docs: Add Maple Mini informationMarti Bolivar2011-05-261-1/+1
| | | | | Flesh out and uncomment maple-mini.rst. Add links to pieces of it in various appropriate places throughout the rest of the documentation.
* Docs: lang/api/constants.rst touchupsMarti Bolivar2011-05-261-50/+44
| | | | Mostly, make it less pedantic. Also some stylistic and content fixes.
* 0.0.10 docs RCMarti Bolivar2011-05-234-8/+10
|
* analogWrite() docs typoMarti Bolivar2011-05-231-1/+1
|
* Docs: removing reference to String class.Marti Bolivar2011-05-171-9/+2
|
* Docs: More complete board-specific values list.Marti Bolivar2011-05-131-7/+34
|
* Putting updated HardwareTimer back into the build.Marti Bolivar2011-05-062-357/+246
| | | | | | | | | | | | | | | HardwareTimer was removed from the build when the timer refactor was done; this redoes it in terms of the new timer.h interface. A variety of conflicting or badly designed bits were deprecated or removed. I'm still not satisfied with this interface, as it's going to make life difficult moving forward to high-density chips, where the addition of basic timers means that the capture/compare methods won't apply in some cases. However, we need to get 0.0.10 out the door, so it'll have to do for now. The docs are up to date, and contain a warning that the Wirish API isn't stable and a recommendation to use libmaple proper.
* Documentation link fixes.Marti Bolivar2011-05-051-13/+18
| | | | Fixing some Sphinx error messages.
* SerialUSB fixups.Marti Bolivar2011-05-041-8/+7
|
* SPI refactor.Marti Bolivar2011-04-281-107/+108
| | | | | | | | | | | | | | | | | Still a polling driver, but the libmaple proper interface exposes enough that users enable the various interrupts and define their own IRQ handlers if they feel like it. Wirish HardwareSPI interface was largely redone; it's more like the Arduino implementation now, although there are some differences when I didn't like their API. The old methods are still there, but are deprecated and slated for deletion in 0.1.0. New board-specific values: BOARD_NR_SPI, BOARD_SPIx_NSS_PIN, BOARD_SPIx_MOSI_PIN, BOARD_SPIx_MISO_PIN, and BOARD_SPIx_SCK_PIN, for x from 1 to BOARD_NR_SPI. Documentation was updated appropriately.
* boardUsesPin() docs tweak.Marti Bolivar2011-04-281-3/+3
|
* 0.0.10 Documentation checkpoint.Marti Bolivar2011-04-2691-465/+316
| | | | | | | | | | | | | | 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
* Better debug port support.Marti Bolivar2011-04-253-2/+82
| | | | | | | | | | | - gpio.h: afio_mapr_swj_config() renamed afio_cfg_debug_ports() - [new] wirish_debug.h: disableDebugPorts(), enableDebugPorts() - Maple, Maple Native, and Maple RET6 PIN_MAPs are now larger by 5, have mappings for the extra JTAG/SW pins. Documentation was updated appropriately.
* Docs tweaks.Marti Bolivar2011-04-251-4/+4
| | | | Blocking fixes for 0.0.10; other changes.
* 0.0.10 documentation checkpoint.Marti Bolivar2011-04-251-4/+1
| | | | | Merging in the standalone refactor docs, etc. The individual libmaple API pages are going to need to get redone.
* Reverting "Rewrote Print class."Marti Bolivar2011-04-122-48/+22
| | | | This reverts commit 8bd3cebbee62e2dd7e961b149cc8bb0e980eaf88.
* Adding CLOCK_SPEED_MHZ and CLOCK_SPEED_HZ as derived board-specific values.Marti Bolivar2011-04-081-0/+6
|
* USART refactor.Marti Bolivar2011-04-071-1/+4
|
* Board-specific values; corresponding QA test generalizations.Marti Bolivar2011-03-309-31/+227
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-113-144/+99
|
* USBSerial docs fix.Marti Bolivar2011-03-041-11/+11
|
* Rewrote Print class.Marti Bolivar2011-02-242-22/+48
| | | | | | | | | | | | | | | | | | | | | | | | | | | The old Print class couldn't print uint64 values, and featured hand-hacked functionality better handled by snprintf(). Redid it using snprintf(), using "[u]int[8,16,32,64]" types for more clarity, and eliminated some private methods in favor of auxiliary functions in Print.cpp. Breaking compatibility with original implementation in three ways: - Print::print(double) is now accurate to 6 digits, rather than 2; this is consistent with the default behavior of the %f format specifier, and if you're using floating point, it's slow enough that you probably want the increased accuracy. - The only bases you can print a number to are 2, 8, 10, and 16. 8, 10, and 16 already have format specifiers, and 2 is an important special case; others complicate matters unnecessarily. - Printing numbers in bases other than 10 treats them as unsigned quantities (i.e., won't print '-' characters). This is more consistent with C++'s behavior for hexadecimal and octal literals (e.g., 0xFFFFFFFF has type uint32). Updated HardwareSerial and USBSerial class documentation to reflect the new behavior.
* docs fixesMarti Bolivar2011-02-162-8/+23
|
* Fixed docs bug where we say "long" when we mean "long long"Marti Bolivar2011-02-0920-148/+161
|
* Documentation bugfixesMarti Bolivar2011-02-083-21/+39
|
* removed flush() from SerialUSB docs.Marti Bolivar2010-12-211-6/+0
|
* Finalized 0.0.9 documentation.Marti Bolivar2010-12-1520-199/+789
|
* cleaning up previous commits.Marti Bolivar2010-12-0390-6714/+0
| | | | | | note that addition of new files under docs/source/lang/api and docs/source/lang/cpp which were just copies of files in docs/source/lang/ imply that change history is lost to git.
* docs, now with styleHanna Mendes Levitin2010-12-0192-0/+6738
|
* New documentation content is done. Next step is to theme.Marti Bolivar2010-11-294-15/+23
|
* Finished converting the Arduino docsMarti Bolivar2010-11-2987-1148/+1534
|
* reorganized all the arduino/ docs into a lang/ subdirectory sinceMarti Bolivar2010-11-28100-0/+6891
they're properly CC attributed now.
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-15 08:16:33 +0000