Skip to content

Commit 2bc8e55

Browse files
clean up docs a bit
Signed-off-by: mateoconlechuga <[email protected]>
1 parent 7cc743d commit 2bc8e55

File tree

4 files changed

+28
-13
lines changed

4 files changed

+28
-13
lines changed

docs/headers/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
.. _headers:
22

3-
CE Toolchain Specific Headers
4-
=============================
3+
Miscellaneous Headers
4+
=====================
55

66
These headers are CE specific, and contain various defines and prototypes.
77

88
.. toctree::
99
:maxdepth: 1
1010
:glob:
1111

12-
tice
13-
intce
1412
compression
13+
intce
14+
tice

docs/headers/tice.rst

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,20 @@ tice.h
99
1010
This header provides backwards compatibility for code written before the header files were split up.
1111

12+
.. important::
13+
14+
This header is provided for backwards compatibility only.
15+
For new projects, it is recommended that the required header be used directly.
16+
1217
.. contents:: :local:
1318
:depth: 3
1419

15-
API Documentation
16-
-----------------
20+
Included Header Files
21+
---------------------
22+
23+
.. toctree::
24+
:maxdepth: 1
25+
:glob:
1726

18-
.. doxygenfile:: tice.h
19-
:project: CE C/C++ Toolchain
27+
headers/sys/index
28+
headers/ti/index

src/ce/sys/timers.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,10 @@ int usleep(useconds_t usec);
267267
*/
268268
void boot_WaitShort(void);
269269

270+
/* @cond */
271+
#define timer_GetLow(n) (_Pragma("GCC warning \"'timer_GetLow' is deprecated, use 'timer_Get' or 'timer_GetSafe' instead as appropriate\"") (uint24_t)timer_Get(n))
272+
/* @endcond */
273+
270274
#ifdef __cplusplus
271275
}
272276
#endif

src/ce/tice.h

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
* @brief Core CE define file
77
*/
88

9-
#ifndef _TICE_H
10-
#define _TICE_H
9+
#ifndef TICE_H
10+
#define TICE_H
1111

1212
#include <sys/basicusb.h>
1313
#include <sys/lcd.h>
@@ -20,14 +20,18 @@
2020
#include <ti/flags.h>
2121
#include <ti/getcsc.h>
2222
#include <ti/getkey.h>
23-
#include <ti/screen.h>
23+
#include <ti/graph.h>
2424
#include <ti/info.h>
25+
#include <ti/python.h>
2526
#include <ti/real.h>
27+
#include <ti/screen.h>
2628
#include <ti/tokens.h>
2729
#include <ti/ui.h>
2830
#include <ti/vars.h>
2931

3032
/* Compatibility defines */
33+
34+
/* @cond */
3135
#define prgm_CleanUp()
3236
#define pgrm_CleanUp()
3337
#define memset_fast memset
@@ -48,6 +52,4 @@
4852
#define asm_ClrTxtShd os_ClrTxtShd
4953
/* @endcond */
5054

51-
#define timer_GetLow(n) (_Pragma("GCC warning \"'timer_GetLow' is deprecated, use 'timer_Get' or 'timer_GetSafe' instead as appropriate\"") (uint24_t)timer_Get(n))
52-
5355
#endif

0 commit comments

Comments
 (0)