Skip to content

Commit 6773f42

Browse files
author
andygock
committed
Update docs
1 parent 900f21e commit 6773f42

File tree

2 files changed

+18
-16
lines changed

2 files changed

+18
-16
lines changed

Doxyfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1666,7 +1666,7 @@ EXTRA_SEARCH_MAPPINGS =
16661666
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
16671667
# The default value is: YES.
16681668

1669-
GENERATE_LATEX = NO
1669+
GENERATE_LATEX = YES
16701670

16711671
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
16721672
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
@@ -1837,7 +1837,7 @@ LATEX_TIMESTAMP = NO
18371837
# readers/editors.
18381838
# The default value is: NO.
18391839

1840-
GENERATE_RTF = NO
1840+
GENERATE_RTF = YES
18411841

18421842
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
18431843
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,47 +7,49 @@ Maintained by Andy Gock
77

88
https://github.com/andygock/avr-uart
99

10-
Derived from original library by Peter Fleury
10+
Derived from original library by Peter Fleury.
1111

12-
Interrupt UART library using the built-in UART with transmit and receive circular buffers.
12+
Interrupt driven UART library using the built-in UART with circular transmit and receive buffers.
1313

1414
An interrupt is generated when the UART has finished transmitting or
1515
receiving a byte. The interrupt handling routines use circular buffers
1616
for buffering received and transmitted data.
1717

1818
## Setting up
1919

20-
The `UART_RXn_BUFFER_SIZE` and `UART_TXn_BUFFER_SIZE` constants define
21-
the size of the circular buffers in bytes. Note that these constants must be a power of 2.
22-
You may need to adapt this constants to your target and your application by adding to your
23-
compiler options:
20+
The `UART_RXn_BUFFER_SIZE` and `UART_TXn_BUFFER_SIZE` symbols define
21+
the size of the circular buffers in bytes. These values **must be a power of 2**.
22+
You may need to adapt this symbols to your target and your application by adding into your compiler options:
2423

2524
-DUART_RXn_BUFFER_SIZE=nn -DUART_TXn_BUFFER_SIZE=nn
2625

27-
`RXn` and `TXn` refer to UART number, for UART3 with 128 byte buffers, add:
26+
`RXn` and `TXn` refer to the UART number, for UART3 with 128 byte buffers, add:
2827

2928
-DUART_RX3_BUFFER_SIZE=128 -DUART_TX3_BUFFER_SIZE=128
3029

31-
UART0 is always enabled by default, to enable the other available UARTs, add the following
32-
to your compiler options (or symbol options), for the relevant USART number:
30+
UART0 is always enabled by default, to enable the other available UARTs, add the following to your compiler's symbol options for the relevant UART (also known as USART) number.
3331

3432
-DUSART1_ENABLED -DUSART2_ENABLED -DUSART3_ENABLED
3533

36-
To enable large buffer support (over 256 bytes, up to 2^16 bytes) use:
34+
To enable large buffer support (over 256 bytes, up to 2^15 bytes) use:
3735

3836
-DUSARTn_LARGE_BUFFER
3937

40-
Where n = USART number.
38+
Where n = USART number. The maximum buffer size is 32768.
4139

42-
Supports AVR devices with up to 4 hardware USARTs.
40+
This library supports AVR devices with up to 4 hardware USARTs.
4341

4442
### Compiler flags
4543

46-
- AVR/GNU C compiler requires the `-std=gnu99` flag.
44+
AVR/GNU C compiler requires the `-std=gnu99` flag.
4745

4846
## Documentation
4947

50-
Doxygen based documentation will be coming soon.
48+
Doxygen based documentation can be viwed at:
49+
50+
* HTML: <https://andygock.github.io/avr-uart-documentation/html/index.html>
51+
* PDF: <https://andygock.github.io/avr-uart-documentation/latex/refman.pdf>
52+
* RTF: <https://andygock.github.io/avr-uart-documentation/rtf/refman.rtf>
5153

5254
## Notes
5355

0 commit comments

Comments
 (0)