diff --git a/ql/cashflows/indexedcashflow.hpp b/ql/cashflows/indexedcashflow.hpp index b721e74b5b4..a74fce488d4 100644 --- a/ql/cashflows/indexedcashflow.hpp +++ b/ql/cashflows/indexedcashflow.hpp @@ -18,7 +18,7 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file simplecashflow.hpp +/*! \file indexedcashflow.hpp \brief Cash flow dependent on an index ratio (NOT a coupon, i.e. no accruals) */ diff --git a/ql/cashflows/inflationcoupon.hpp b/ql/cashflows/inflationcoupon.hpp index 0a1ddc06c44..197d8218231 100644 --- a/ql/cashflows/inflationcoupon.hpp +++ b/ql/cashflows/inflationcoupon.hpp @@ -17,7 +17,7 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file floatingratecoupon.hpp +/*! \file inflationcoupon.hpp \brief Coupon paying a variable index-based rate */ diff --git a/ql/experimental/asian/analytic_cont_geom_av_price_heston.hpp b/ql/experimental/asian/analytic_cont_geom_av_price_heston.hpp index e3a54f29f28..24fc568440d 100644 --- a/ql/experimental/asian/analytic_cont_geom_av_price_heston.hpp +++ b/ql/experimental/asian/analytic_cont_geom_av_price_heston.hpp @@ -17,7 +17,7 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file analytic_cont_geom_av_price.hpp +/*! \file analytic_cont_geom_av_price_heston.hpp \brief Analytic engine for continuous geometric average price Asian in the Heston model */ diff --git a/ql/experimental/asian/analytic_discr_geom_av_price_heston.hpp b/ql/experimental/asian/analytic_discr_geom_av_price_heston.hpp index b8f5b6abf25..30e9e175464 100644 --- a/ql/experimental/asian/analytic_discr_geom_av_price_heston.hpp +++ b/ql/experimental/asian/analytic_discr_geom_av_price_heston.hpp @@ -17,8 +17,8 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file analytic_cont_geom_av_price.hpp - \brief Analytic engine for continuous geometric average price Asian +/*! \file analytic_discr_geom_av_price_heston.hpp + \brief Analytic engine for discrete geometric average price Asian in the Heston model */ diff --git a/ql/experimental/barrieroption/discretizeddoublebarrieroption.hpp b/ql/experimental/barrieroption/discretizeddoublebarrieroption.hpp index 5689db3f88a..4813b5613b7 100644 --- a/ql/experimental/barrieroption/discretizeddoublebarrieroption.hpp +++ b/ql/experimental/barrieroption/discretizeddoublebarrieroption.hpp @@ -17,8 +17,8 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file discretizedbarrieroption.hpp - \brief discretized barrier option +/*! \file discretizeddoublebarrieroption.hpp + \brief discretized double barrier option */ #ifndef quantlib_discretized_double_barrier_option_h diff --git a/ql/experimental/commodities/commoditytype.hpp b/ql/experimental/commodities/commoditytype.hpp index 0b398f47fad..8cf3d745864 100644 --- a/ql/experimental/commodities/commoditytype.hpp +++ b/ql/experimental/commodities/commoditytype.hpp @@ -17,7 +17,7 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file commodity.hpp +/*! \file commoditytype.hpp \brief commodity type */ diff --git a/ql/experimental/commodities/paymentterm.hpp b/ql/experimental/commodities/paymentterm.hpp index 0ce5fe25878..0122f5e3ce5 100644 --- a/ql/experimental/commodities/paymentterm.hpp +++ b/ql/experimental/commodities/paymentterm.hpp @@ -17,8 +17,8 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file commoditypricinghelpers.hpp - \brief Commodity pricing helpers +/*! \file paymentterm.hpp + \brief Payment term */ #ifndef quantlib_payment_term_hpp diff --git a/ql/experimental/commodities/unitofmeasureconversion.hpp b/ql/experimental/commodities/unitofmeasureconversion.hpp index 1649ecceca8..6641f521349 100644 --- a/ql/experimental/commodities/unitofmeasureconversion.hpp +++ b/ql/experimental/commodities/unitofmeasureconversion.hpp @@ -18,8 +18,8 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file energycommodity.hpp - \brief Energy commodity +/*! \file unitofmeasureconversion.hpp + \brief Unit of measure conversion */ #ifndef quantlib_unit_of_measure_conversion_hpp diff --git a/ql/experimental/finitedifferences/fdextoujumpvanillaengine.hpp b/ql/experimental/finitedifferences/fdextoujumpvanillaengine.hpp index 11c195ed54f..da6f30041f5 100644 --- a/ql/experimental/finitedifferences/fdextoujumpvanillaengine.hpp +++ b/ql/experimental/finitedifferences/fdextoujumpvanillaengine.hpp @@ -17,7 +17,7 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file fdsimplebsswingengine.hpp +/*! \file fdextoujumpvanillaengine.hpp \brief Finite Differences Ornstein Uhlenbeck plus exponential jumps engine for vanilla options */ diff --git a/ql/experimental/finitedifferences/fdornsteinuhlenbeckvanillaengine.hpp b/ql/experimental/finitedifferences/fdornsteinuhlenbeckvanillaengine.hpp index ff85219f8ec..d8b3797dbb0 100644 --- a/ql/experimental/finitedifferences/fdornsteinuhlenbeckvanillaengine.hpp +++ b/ql/experimental/finitedifferences/fdornsteinuhlenbeckvanillaengine.hpp @@ -17,8 +17,8 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file fdblackscholesvanillaengine.hpp - \brief Finite-Differences Black Scholes vanilla option engine +/*! \file fdornsteinuhlenbeckvanillaengine.hpp + \brief Finite-Differences Ornstein Uhlenbeck vanilla option engine */ #ifndef quantlib_fd_ornstein_uhlenbeck_vanilla_engine_hpp diff --git a/ql/experimental/finitedifferences/fdsimpleklugeextouvppengine.hpp b/ql/experimental/finitedifferences/fdsimpleklugeextouvppengine.hpp index 99bfd072b5e..b56eaeacb53 100644 --- a/ql/experimental/finitedifferences/fdsimpleklugeextouvppengine.hpp +++ b/ql/experimental/finitedifferences/fdsimpleklugeextouvppengine.hpp @@ -17,7 +17,7 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file fdsimpleextoujumpswingengine.hpp +/*! \file fdsimpleklugeextouvppengine.hpp \brief Finite Differences engine for simple vpp options */ diff --git a/ql/experimental/inflation/yoycapfloortermpricesurface.hpp b/ql/experimental/inflation/yoycapfloortermpricesurface.hpp index 0465320e17b..c2b0cc8fef9 100644 --- a/ql/experimental/inflation/yoycapfloortermpricesurface.hpp +++ b/ql/experimental/inflation/yoycapfloortermpricesurface.hpp @@ -18,7 +18,7 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file yoyoptionlethelpers.hpp +/*! \file yoycapfloortermpricesurface.hpp \brief yoy inflation cap and floor term-price structure */ diff --git a/ql/instruments/makeyoyinflationcapfloor.hpp b/ql/instruments/makeyoyinflationcapfloor.hpp index f94eeac85be..8fb8aef7e00 100644 --- a/ql/instruments/makeyoyinflationcapfloor.hpp +++ b/ql/instruments/makeyoyinflationcapfloor.hpp @@ -19,7 +19,7 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file makecapfloor.hpp +/*! \file makeyoyinflationcapfloor.hpp \brief Helper class to instantiate standard yoy inflation cap/floor. */ diff --git a/ql/math/generallinearleastsquares.hpp b/ql/math/generallinearleastsquares.hpp index 48586f4f50f..6fe77ad90b6 100644 --- a/ql/math/generallinearleastsquares.hpp +++ b/ql/math/generallinearleastsquares.hpp @@ -20,7 +20,7 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file linearleastsquaresregression.hpp +/*! \file generallinearleastsquares.hpp \brief general linear least square regression */ diff --git a/ql/math/interpolations/backwardflatlinearinterpolation.hpp b/ql/math/interpolations/backwardflatlinearinterpolation.hpp index a621ba9e86c..772eb111a2d 100644 --- a/ql/math/interpolations/backwardflatlinearinterpolation.hpp +++ b/ql/math/interpolations/backwardflatlinearinterpolation.hpp @@ -17,7 +17,7 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file bilinearinterpolation.hpp +/*! \file backwardflatlinearinterpolation.hpp \brief backflat interpolation in first component, linear in second component */ diff --git a/ql/math/interpolations/flatextrapolation2d.hpp b/ql/math/interpolations/flatextrapolation2d.hpp index 564b1ff38a1..7dec8fef5c5 100644 --- a/ql/math/interpolations/flatextrapolation2d.hpp +++ b/ql/math/interpolations/flatextrapolation2d.hpp @@ -17,7 +17,7 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file +/*! \file flatextrapolation2d.hpp \brief abstract base classes for 2-D flat extrapolations */ diff --git a/ql/methods/finitedifferences/operators/fdmg2op.hpp b/ql/methods/finitedifferences/operators/fdmg2op.hpp index 684cea45745..27b14aefaf8 100644 --- a/ql/methods/finitedifferences/operators/fdmg2op.hpp +++ b/ql/methods/finitedifferences/operators/fdmg2op.hpp @@ -17,8 +17,8 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file fdmhullwhiteop.hpp - \brief FDM operator for the Hull-White interest rate model +/*! \file fdmg2op.hpp + \brief FDM G2 operator */ #ifndef quantlib_fdm_g2_op_hpp diff --git a/ql/methods/finitedifferences/utilities/squarerootprocessrndcalculator.hpp b/ql/methods/finitedifferences/utilities/squarerootprocessrndcalculator.hpp index 2bf489b0614..761ba363849 100644 --- a/ql/methods/finitedifferences/utilities/squarerootprocessrndcalculator.hpp +++ b/ql/methods/finitedifferences/utilities/squarerootprocessrndcalculator.hpp @@ -18,7 +18,7 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file bsmrndcalculator.hpp +/*! \file squarerootprocessrndcalculator.hpp \brief risk neutral terminal density calculator for the square root process */ diff --git a/ql/pricingengines/asian/mc_discr_geom_av_price_heston.hpp b/ql/pricingengines/asian/mc_discr_geom_av_price_heston.hpp index ccc5ae63216..f5869a5c469 100644 --- a/ql/pricingengines/asian/mc_discr_geom_av_price_heston.hpp +++ b/ql/pricingengines/asian/mc_discr_geom_av_price_heston.hpp @@ -17,7 +17,7 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file mc_discr_arith_av_price_heston.hpp +/*! \file mc_discr_geom_av_price_heston.hpp \brief Heston MC engine for discrete geometric average price Asian */ diff --git a/ql/pricingengines/lookback/analyticcontinuouspartialfixedlookback.hpp b/ql/pricingengines/lookback/analyticcontinuouspartialfixedlookback.hpp index 594e05d3128..af8616f2b4c 100644 --- a/ql/pricingengines/lookback/analyticcontinuouspartialfixedlookback.hpp +++ b/ql/pricingengines/lookback/analyticcontinuouspartialfixedlookback.hpp @@ -19,7 +19,7 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file analyticcontinuousfixedlookback.hpp +/*! \file analyticcontinuouspartialfixedlookback.hpp \brief Analytic engine for continuous fixed-strike lookback */ diff --git a/ql/pricingengines/lookback/analyticcontinuouspartialfloatinglookback.hpp b/ql/pricingengines/lookback/analyticcontinuouspartialfloatinglookback.hpp index 7517aa63216..d9556333144 100644 --- a/ql/pricingengines/lookback/analyticcontinuouspartialfloatinglookback.hpp +++ b/ql/pricingengines/lookback/analyticcontinuouspartialfloatinglookback.hpp @@ -19,7 +19,7 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file analyticcontinuousfloatinglookback.hpp +/*! \file analyticcontinuouspartialfloatinglookback.hpp \brief Analytic engine for continuous floating-strike lookback */ diff --git a/ql/pricingengines/vanilla/hestonexpansionengine.hpp b/ql/pricingengines/vanilla/hestonexpansionengine.hpp index 952b8471fdb..70cf677ec02 100644 --- a/ql/pricingengines/vanilla/hestonexpansionengine.hpp +++ b/ql/pricingengines/vanilla/hestonexpansionengine.hpp @@ -17,7 +17,7 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file analytichestonengine.hpp +/*! \file hestonexpansionengine.hpp \brief analytic Heston expansion engine */ diff --git a/ql/processes/coxingersollrossprocess.hpp b/ql/processes/coxingersollrossprocess.hpp index 5ae53658193..1763582ccbb 100644 --- a/ql/processes/coxingersollrossprocess.hpp +++ b/ql/processes/coxingersollrossprocess.hpp @@ -18,7 +18,7 @@ FOR A PARTICULAR PURPOSE. See the license for more details. */ -/*! \file coxingersollross.hpp +/*! \file coxingersollrossprocess.hpp \brief CoxIngersollRoss process */