knightfox75/nds_nflib
1
Fork 0
mirror of https://github.com/knightfox75/nds_nflib.git synced 2025-06-18 16:55:32 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

doxygen: Create documentation groups

Browse Source
This commit is contained in:
Antonio Niño Díaz 2023-04-30 02:15:43 +01:00
parent 687cc91511
commit 9dde256592
3 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
include/nf_basic.h
View File

@ -13,6 +13,15 @@ extern "C" {
#ifndef __NF_BASIC_H__
#define __NF_BASIC_H__
/// @file nf_basic.h
/// @brief General functions of NFLib
/// @defgroup nf_basic General functions of NFLib
///
/// Functions related to error handling and other general settings.
///
/// @{
#include <nds.h>
/// Root folder used by NFLib
@ -96,6 +105,8 @@ void NF_DmaMemCopy(void* destination, const void* source, u32 size);
/// @return The language ID.
extern u8 NF_GetLanguage(void);
/// @}
#endif
#ifdef __cplusplus

11
include/nf_sprite256.h
View File

@ -13,6 +13,15 @@ extern "C" {
#ifndef __NF_SPRITE256_H__
#define __NF_SPRITE256_H__
/// @file nf_sprite256.h
/// @brief Functions related to 256 color sprites.
/// @defgroup nf_sprite256 256 color sprites
///
/// Functions to load and handle 256 color sprites.
///
/// @{
#include <nds.h>
/// Maximum number of slots of 256 color sprites
@ -423,6 +432,8 @@ void NF_SpriteUpdatePalette(u8 screen, u8 pal);
/// @param b Blue component (0 - 31).
void NF_SpriteGetPalColor(u8 screen, u8 pal, u8 number, u8* r, u8* g, u8* b);
/// @}
#endif
#ifdef __cplusplus

11
include/nf_tiledbg.h
View File

@ -13,6 +13,15 @@ extern "C" {
#ifndef __NF_TILEDBG_H__
#define __NF_TILEDBG_H__
/// @file nf_tiledbg.h
/// @brief Functions related to regular tiled backgrounds.
/// @defgroup nf_tiledbg Functions related to regular tiled backgrounds.
///
/// Functions related to regular (non-affine) tiled backgrounds.
///
/// @{
#include <nds.h>
/// Maximum number of slots of tiled background
@ -537,6 +546,8 @@ void NF_SetTileVflip(u8 screen, u8 layer, u16 tile_x, u16 tile_y);
/// @param rotation Rotation value.
void NF_RotateTileGfx(u8 slot, u16 tile, u8 rotation);
/// @}
#endif
#ifdef __cplusplus