gbdev/rgbds
1
0
Fork 0
mirror of https://github.com/gbdev/rgbds.git synced 2025-11-20 10:12:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove redundant @-style doc comment tags (#1641)

Browse Source
This commit is contained in:
Rangi
2025-01-29 19:56:28 -05:00
committed by GitHub
parent e20347e38c
commit b35e9d86fb
14 changed files with 50 additions and 144 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
include/linkdefs.hpp
View File

@@ -94,21 +94,17 @@ extern struct SectionTypeInfo {
// Tells whether a section has data in its object file definition,
// depending on type.
// @param type The section's type
// @return `true` if the section's definition includes data
static inline bool sect_HasData(SectionType type) {
assume(type != SECTTYPE_INVALID);
return type == SECTTYPE_ROM0 || type == SECTTYPE_ROMX;
}
// Computes a memory region's end address (last byte), eg. 0x7FFF
// @return The address of the last byte in that memory region
// Returns a memory region's end address (last byte), e.g. 0x7FFF
static inline uint16_t endaddr(SectionType type) {
return sectionTypeInfo[type].startAddr + sectionTypeInfo[type].size - 1;
}
// Computes a memory region's number of banks
// @return The number of banks, 1 for regions without banking
// Returns a memory region's number of banks, or 1 for regions without banking
static inline uint32_t nbbanks(SectionType type) {
return sectionTypeInfo[type].lastBank - sectionTypeInfo[type].firstBank + 1;
}