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

include/link/object.hpp

@@ -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

include/link/output.hpp

@@ -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.

include/link/patch.hpp

@@ -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

include/link/section.hpp

@@ -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

include/link/symbol.hpp

@@ -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);

include/linkdefs.hpp

@@ -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;
 }