You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
AppendDoxref() was an attempt to allow source dependencies to add doxygen tag files to an Environment variable DOXREF so doxygen apidocs builds could link to the apidocs pages of dependencies. For example, where the logx library uses a log4cpp type, the logx html apidocs would link those type names to the log4cpp documentation. This was difficult to make flexible and robust. The tag files for external dependencies have to be updated, both to match the version of the dependency and the latest location of the generated html files. For internal dependencies, like for aeros documentation to include the logx libraries, then the logx apidocs builder had to build the tag file and then supply it to the parent. And for all this complication, I don't think anyone really uses or relies on the tag references. Probably the apidocs themselves are not used as much anymore.
External references will probably never work, and might be better replaced with a link in the project's top-level documentation to the online documentation for each of the project's external dependencies.
The more recent approach to project-wide documentation for all internal references is to accumulate all the doxygen sources from the subdirectories and generate one Doxyfile which scans all of them. ASPEN uses this approach.
So this issue is to consider deprecating and eventually removing all the AppendDoxref() code. Start out with keeping the Environment method but making it a no-op, while removing all the uses of it in the doxygen.py tool.
The text was updated successfully, but these errors were encountered:
AppendDoxref()
was an attempt to allow source dependencies to add doxygen tag files to an Environment variableDOXREF
so doxygen apidocs builds could link to the apidocs pages of dependencies. For example, where thelogx
library uses alog4cpp
type, thelogx
html apidocs would link those type names to thelog4cpp
documentation. This was difficult to make flexible and robust. The tag files for external dependencies have to be updated, both to match the version of the dependency and the latest location of the generated html files. For internal dependencies, like foraeros
documentation to include thelogx
libraries, then thelogx
apidocs builder had to build the tag file and then supply it to the parent. And for all this complication, I don't think anyone really uses or relies on the tag references. Probably the apidocs themselves are not used as much anymore.External references will probably never work, and might be better replaced with a link in the project's top-level documentation to the online documentation for each of the project's external dependencies.
The more recent approach to project-wide documentation for all internal references is to accumulate all the doxygen sources from the subdirectories and generate one Doxyfile which scans all of them. ASPEN uses this approach.
So this issue is to consider deprecating and eventually removing all the
AppendDoxref()
code. Start out with keeping the Environment method but making it a no-op, while removing all the uses of it in the doxygen.py tool.The text was updated successfully, but these errors were encountered: