Fix Doxygen warnings #327
Open
Fix Doxygen warnings #327
Conversation
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
- add missing groups - correct some filenames - document some missing parameters - leave the warning about max graph nodes for now
QuantLib has DOT_GRAPH_MAX_NODES set to 150. Don't need that many. The warnings were as follows: - IborIndex: 30 - Calendar: 22 - GenericEngine: 50 so 100 gives plenty of room for now.
This is the value used in QuantLib. It is needed since without it we get the warning: Inheritance graph for 'XMLSerializable' not generated, too many nodes (112), threshold is 80. Consider increasing DOT_GRAPH_MAX_NODES.
The main reason to add this is so that fully scoped names are used in the quantext.tag file that is then consumed by Doxygen when generating the docs for OREData. Without this, there are a number of warnings of the form: Detected potential recursive class relation between class QuantExt::BondRepo::arguments and base class arguments! The reason is that when HIDE_SCOPE_NAMES = YES, we have: <compound kind="class"> <name>QuantExt::BondOption::results</name> <filename>class_quant_ext_1_1_bond_option_1_1results.html</filename> <base>results</base> </compound> in the tag file and we get the recursive warning because Doxygen thinks that QuantExt::BondOption::results is inheriting from itself. When HIDE_SCOPE_NAMES = NO, we have: <compound kind="class"> <name>QuantExt::BondOption::results</name> <filename>class_quant_ext_1_1_bond_option_1_1results.html</filename> <base>QuantLib::Bond::results</base> </compound> and there is no ambiguity i.e. Doxygen knows that QuantExt::BondOption::results is deriving from a different type namely QuantLib::BondOption::results.
Similar to the change in quantext Doxygen, need to add this so that
fully scoped names are used in the ored.tag file that is then consumed
by Doxygen when generating the docs for OREAnalytics.
Without this, there are a number of warnings of the form:
Detected potential recursive class relation between class
ore::data::CommodityPositionInstrumentWrapper::arguments and base
class arguments!
When Doxygen is processing ored.tag during OREAnalytics doc generation, it gives warnings: Incomplete input: scope for class ore::data::BaseCorrelationCurve::QuoteData::LessDataKey not found! Incomplete input: scope for class ore::data::BaseCorrelationCurve::QuoteData::LessReal not found! This change excludes the section from Doxygen processing so the nested structs do not show up in the tag file and hence do not give a warning during OREAnalytics doc generation. Nothing is lost in the OREData documentation because these private structs are not documented in any case e.g. AdjustForLossResults is not documented.
Use same value as QuantLib i.e. 150. The warnings with the value set to 20 were for the following classes with the associated node size value: - Trade: 55 - ore::analytics::Analytic: 27 - ore::analytics::Analytic::Impl: 27 - ore::analytics::SaccrTradeData::Impl: 26 - ore::analytics::Trade: 55 - ore::analytics::XMLSerializable: 131
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
There are a large amount of Doxygen warnings when
ORE_BUILD_DOCis set totrueand the doc generation is run. This pull request fixes those warnings.