Add Doxygen documentation for Cpl::Table - #33
Merged
Conversation
Document public types and methods in Table.h, register the cpl_table group, and include Table.h in the Doxygen input list. Private members are left undocumented. Co-authored-by: igor.ermolaev <igor.ermolaev@altezza.org>
ermig1979
marked this pull request as ready for review
August 27, 2026 07:53
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add Doxygen comments for the types and functions declared in
src/Cpl/Table.h.Changes
Runtime behavior is unchanged. Comments follow the style used by
Cpl::Log,Cpl::ArgsParser,Cpl::Console,Cpl::Htmland the performance types (/*!,\brief/\param/\return/\note). Private members are not documented.Documented:
Cpl::Table(constructor and public methods)Cpl::Table::AlignmentandCpl::Table::Colorenumerations (including enumerators)Also:
cpl_tabledocumentation group inprj/txt/DoxygenGroups.txtTable.hin the Doxygen input list inprj/txt/DoxygenConfig.txtTest plan
Testwith CMake/g++ Release.TableSimpleandTableSortablepassed (Test -i=Table).Table.hwithWARN_IF_UNDOCUMENTEDandWARN_IF_DOC_ERROR. NoTable.hdocumentation warnings. Thecpl_tablegroup listsCpl::Table; public members (Alignment,Color, constructor,Height,Width,SetHeader,SetRowProp,SetCell,GenerateText,GenerateHtml) were extracted. Private members (RowProp,Header,Cell,ExpandText,Init, fields) were not extracted in HTML.docs/helpcan be refreshed later withprj/cmd/GenerateHelp.cmd.