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

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

View File

@@ -4,12 +4,9 @@
#define RGBDS_LINK_OBJECT_HPP
// Read an object (.o) file, and add its info to the data structures.
// @param fileName A path to the object file to be read
// @param i The ID of the file
void obj_ReadFile(char const *fileName, unsigned int i);
void obj_ReadFile(char const *fileName, unsigned int fileID);
// Sets up object file reading
// @param nbFiles The number of object files that will be read
void obj_Setup(unsigned int nbFiles);
#endif // RGBDS_LINK_OBJECT_HPP

View File

@@ -6,12 +6,9 @@
struct Section;
// Registers a section for output.
// @param section The section to add
void out_AddSection(Section const &section);
// Finds an assigned section overlapping another one.
// @param section The section that is being overlapped
// @return A section overlapping it
Section const *out_OverlappingSection(Section const &section);
// Writes all output (bin, sym, map) files.

View File

@@ -4,7 +4,6 @@
#define RGBDS_LINK_PATCH_HPP
// Checks all assertions
// @return true if assertion failed
void patch_CheckAssertions();
// Applies all SECTIONs' patches to them

View File

@@ -67,16 +67,12 @@ extern std::deque<Assertion> assertions;
// Execute a callback for each section currently registered.
// This is to avoid exposing the data structure in which sections are stored.
// @param callback The function to call for each structure.
void sect_ForEach(void (*callback)(Section &));
// Registers a section to be processed.
// @param section The section to register.
void sect_AddSection(std::unique_ptr<Section> &&section);
// Finds a section by its name.
// @param name The name of the section to look for
// @return A pointer to the section, or `nullptr` if it wasn't found
Section *sect_GetSection(std::string const &name);
// Checks if all sections meet reasonable criteria, such as max size

View File

@@ -42,8 +42,6 @@ void sym_ForEach(void (*callback)(Symbol &));
void sym_AddSymbol(Symbol &symbol);
// Finds a symbol in all the defined symbols.
// @param name The name of the symbol to look for
// @return A pointer to the symbol, or `nullptr` if not found.
Symbol *sym_GetSymbol(std::string const &name);
void sym_DumpLocalAliasedSymbols(std::string const &name);