Skip to content

Commit 2bc581e

Browse files
committed
Fix missing doc groups
1 parent d3e4b9c commit 2bc581e

13 files changed

+33
-24
lines changed

Docs/pages/engines.docs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,18 @@
2727

2828
/*! \defgroup basketengines Basket option engines */
2929

30+
/*! \defgroup bondengines Basket option engines */
31+
3032
/*! \defgroup capfloorengines Cap/floor engines */
3133

3234
/*! \defgroup cliquetengines Cliquet option engines */
3335

3436
/*! \defgroup forwardengines Forward option engines */
3537

38+
/*! \defgroup inflationcapfloorengines Inflation cap/floor engines */
39+
40+
/*! \defgroup lookbackengines Lookback option engines */
41+
3642
/*! \defgroup quantoengines Quanto option engines */
3743

3844
/*! \defgroup swaptionengines Swaption engines */

Docs/pages/termstructures.docs

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,12 @@
1616
FOR A PARTICULAR PURPOSE. See the license for more details.
1717
*/
1818

19-
/*! \defgroup yieldtermstructures Term structures
19+
/*! \defgroup termstructuressss Term structures
20+
21+
@{
22+
*/
23+
24+
/*! \defgroup yieldtermstructures Interest-rate term structures
2025

2126
The abstract class QuantLib::YieldTermStructure provides the common
2227
interface to concrete yield-rate term structure models. Among
@@ -27,3 +32,9 @@
2732
non-redundant part.
2833
*/
2934

35+
/*! \defgroup defaultprobabilitytermstructures Default-probability term structures */
36+
37+
/*! \defgroup inflationtermstructures Inflation term structures */
38+
39+
40+
/*! @} */

ql/experimental/callablebonds/blackcallablebondengine.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ namespace QuantLib {
3838
3939
\warning This class has yet to be tested
4040
41-
\ingroup callablebondengines
41+
\ingroup bondengines
4242
*/
4343
class BlackCallableFixedRateBondEngine
4444
: public CallableFixedRateBond::engine {
@@ -69,7 +69,7 @@ namespace QuantLib {
6969
7070
\warning This class has yet to be tested.
7171
72-
\ingroup callablebondengines
72+
\ingroup bondengines
7373
*/
7474
class BlackCallableZeroCouponBondEngine :
7575
public BlackCallableFixedRateBondEngine {

ql/experimental/callablebonds/treecallablebondengine.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
namespace QuantLib {
3131

3232
//! Numerical lattice engine for callable fixed rate bonds
33-
/*! \ingroup callablebondengines */
33+
/*! \ingroup bondengines */
3434
class TreeCallableFixedRateBondEngine
3535
: public LatticeShortRateModelEngine<CallableBond::arguments,
3636
CallableBond::results> {
@@ -57,7 +57,7 @@ namespace QuantLib {
5757
};
5858

5959
//! Numerical lattice engine for callable zero coupon bonds
60-
/*! \ingroup callablebondengines */
60+
/*! \ingroup bondengines */
6161
class TreeCallableZeroCouponBondEngine
6262
: public TreeCallableFixedRateBondEngine {
6363

ql/experimental/credit/factorspreadedhazardratecurve.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ namespace QuantLib {
3535
structure, i.e., any changes in the latter will be
3636
reflected in this structure as well.
3737
38-
\ingroup termstructures
38+
\ingroup defaultprobabilitytermstructures
3939
*/
4040
class FactorSpreadedHazardRateCurve : public HazardRateStructure {
4141
public:

ql/experimental/credit/lossdistribution.hpp

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,6 @@
3131
namespace QuantLib {
3232

3333
//! Probability formulas and algorithms
34-
/*!
35-
\ingroup probability
36-
*/
3734
class LossDist {
3835
public:
3936
LossDist() = default;
@@ -95,9 +92,6 @@ namespace QuantLib {
9592
};
9693

9794
//! Binomial loss distribution
98-
/*! Binomial loss distribution
99-
\ingroup probability
100-
*/
10195
class LossDistBinomial : public LossDist {
10296
public:
10397
LossDistBinomial (Size nBuckets, Real maximum)
@@ -140,8 +134,6 @@ namespace QuantLib {
140134
141135
John Hull and Alan White, "Valuation of a CDO and nth to default CDS
142136
without Monte Carlo simulation", Journal of Derivatives 12, 2, 2004
143-
144-
\ingroup probability
145137
*/
146138
class LossDistHomogeneous : public LossDist {
147139
public:
@@ -174,8 +166,6 @@ namespace QuantLib {
174166
175167
John Hull and Alan White, "Valuation of a CDO and nth to default CDS
176168
without Monte Carlo simulation", Journal of Derivatives 12, 2, 2004.
177-
178-
\ingroup probability
179169
*/
180170
class LossDistBucketing : public LossDist {
181171
public:
@@ -199,8 +189,6 @@ namespace QuantLib {
199189
/*!
200190
Loss distribution for varying volumes and probabilities of default
201191
via Monte Carlo simulation of independent default events.
202-
203-
\ingroup probability
204192
*/
205193
class LossDistMonteCarlo : public LossDist {
206194
public:

ql/experimental/credit/riskyassetswapoption.hpp

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@
2929
namespace QuantLib {
3030

3131
//! %Option on risky asset swap
32-
/*! \ingroup credit */
3332
class RiskyAssetSwapOption : public Instrument {
3433
public:
3534
RiskyAssetSwapOption(ext::shared_ptr<RiskyAssetSwap> asw,

ql/experimental/credit/spreadedhazardratecurve.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ namespace QuantLib {
3535
structure, i.e., any changes in the latter will be
3636
reflected in this structure as well.
3737
38-
\ingroup termstructures
38+
\ingroup defaultprobabilitytermstructures
3939
*/
4040
class SpreadedHazardRateCurve : public HazardRateStructure {
4141
public:

ql/experimental/credit/syntheticcdo.hpp

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,6 @@ namespace QuantLib {
9999
The pricing algorithm allows for varying notional amounts and
100100
default termstructures of the underlyings.
101101
102-
\ingroup credit
103-
104102
\todo Investigate and fix cases \f$ E_{i+1} < E_i. \f$
105103
*/
106104
class SyntheticCDO : public Instrument {

ql/pricingengines/bond/binomialconvertibleengine.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
namespace QuantLib {
3838

3939
//! Binomial Tsiveriotis-Fernandes engine for convertible bonds
40-
/* \ingroup hybridengines
40+
/* \ingroup bondengines
4141
4242
\test the correctness of the returned value is tested by
4343
checking it against known results in a few corner cases.

0 commit comments

Comments
 (0)