Skip to content

Commit b86e99b

Browse files
committed
Even more documentation updates.
1 parent 5be294d commit b86e99b

5 files changed

Lines changed: 10 additions & 11 deletions

File tree

Doxyfile.in

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
PROJECT_NAME = @PROJECT_NAME@
1515
OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@/docs
1616
INPUT = @CMAKE_SOURCE_DIR@/readme.md \
17-
@CMAKE_SOURCE_DIR@/doc \
1817
@CMAKE_SOURCE_DIR@/src
1918
RECURSIVE = YES
2019
EXTRACT_ALL = @DOXYGEN_EXTRACT_ALL@

readme.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ SuperKey is a fully featured, open source CW / Morse code keyer for amateur radi
66
provide **all keyer functionality** required by the modern ham radio enthusiast, as simply and cheaply as possible.
77
SuperKey is **100% open source**, and always will be - you are free to build, modify, and tinker with your own SuperKey.
88

9-
![Prototype](https://github.com/user-attachments/assets/562650b9-a3b6-4f34-8f54-a3d0bb142bc6)
10-
11-
![Python Interface](https://github.com/user-attachments/assets/ab01b046-c7d4-4f6a-a0b4-01f7c1304780)
9+
![Prototype](https://github.com/user-attachments/assets/562650b9-a3b6-4f34-8f54-a3d0bb142bc6) ![Python Interface](https://github.com/user-attachments/assets/ab01b046-c7d4-4f6a-a0b4-01f7c1304780)
1210

1311
## Features
1412

@@ -54,16 +52,18 @@ for the PCB. The current plan is for SuperKey to be equipped with at least the f
5452
Power is provided via the USB connector. I also plan to add a hardware user interface of some sort, to allow performing
5553
basic functions without requiring a PC connection. The details for this are TBD.
5654

55+
![Hardware Layout](https://github.com/user-attachments/assets/48e51617-bd74-42ce-a9fa-693ca33a8610)
56+
5757
## Documentation
5858

5959
⚠️ _Documentation is incomplete and under construction!_
6060

6161
All documentation for SuperKey is located in the project's [GitHub wiki](https://github.com/xchrishawk/superkey/wiki).
6262

63-
- [User's Guide](https://github.com/xchrishawk/superkey/wiki/User's-Guide) - **NEW USERS START HERE!** User-focused
63+
- [User Guide](https://github.com/xchrishawk/superkey/wiki/User-Guide) - **NEW USERS START HERE!** User-focused
6464
instruction manual for the SuperKey.
65-
- [Developer's Guide](https://github.com/xchrishawk/superkey/wiki/Developer's-Guide) - Documentation for developers who
66-
want to modify the SuperKey software.
65+
- [Developer Guide](https://github.com/xchrishawk/superkey/wiki/Developer-Guide) - Documentation for developers who want
66+
to modify the SuperKey software.
6767
- [Hardware Guide](https://github.com/xchrishawk/superkey/wiki/Hardware-Guide) - Description of SuperKey hardware and
6868
how to build it.
6969

src/main/application/io.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* @brief src/main/application/io.c
2+
* @file src/main/application/io.c
33
* @brief Implementation for the keyer input / output module.
44
*
55
* @author Chris Vig (chris@invictus.so)

src/main/application/io.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* @brief src/main/application/io.h
2+
* @file src/main/application/io.h
33
* @brief Header for the keyer input / output module.
44
*
55
* @author Chris Vig (chris@invictus.so)
@@ -116,7 +116,7 @@ io_polarity_t io_get_polarity( io_pin_t pin );
116116
io_state_t io_get_state( io_pin_t pin );
117117

118118
/**
119-
* @fn io_get_state( io_type_t )
119+
* @fn io_get_state_type( io_type_t )
120120
* @brief Returns the state of the specified I/O type.
121121
* @note This will return `IO_STATE_ON` if *any* pin with this input type is currently `IO_STATE_ON`.
122122
*/

src/main/application/keyer.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ enum
6666
bool keyer_autokey_char( char c );
6767

6868
/**
69-
* @fn keyer_autokey( char const * )
69+
* @fn keyer_autokey_str( char const * )
7070
* @brief Adds the specified string to the keyer's autokey buffer.
7171
* @returns The number of characters that were successfully queued.
7272
*/

0 commit comments

Comments
 (0)