Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct file-docstrings not matching file names #1770

Merged
merged 1 commit into from
Aug 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ql/cashflows/indexedcashflow.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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)
*/

Expand Down
2 changes: 1 addition & 1 deletion ql/cashflows/inflationcoupon.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
4 changes: 2 additions & 2 deletions ql/experimental/asian/analytic_discr_geom_av_price_heston.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion ql/experimental/commodities/commoditytype.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
FOR A PARTICULAR PURPOSE. See the license for more details.
*/

/*! \file commodity.hpp
/*! \file commoditytype.hpp
\brief commodity type
*/

Expand Down
4 changes: 2 additions & 2 deletions ql/experimental/commodities/paymentterm.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions ql/experimental/commodities/unitofmeasureconversion.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down
2 changes: 1 addition & 1 deletion ql/experimental/inflation/yoycapfloortermpricesurface.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down
2 changes: 1 addition & 1 deletion ql/instruments/makeyoyinflationcapfloor.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/

Expand Down
2 changes: 1 addition & 1 deletion ql/math/generallinearleastsquares.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down
2 changes: 1 addition & 1 deletion ql/math/interpolations/backwardflatlinearinterpolation.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down
2 changes: 1 addition & 1 deletion ql/math/interpolations/flatextrapolation2d.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down
4 changes: 2 additions & 2 deletions ql/methods/finitedifferences/operators/fdmg2op.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down
2 changes: 1 addition & 1 deletion ql/pricingengines/asian/mc_discr_geom_av_price_heston.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down
2 changes: 1 addition & 1 deletion ql/pricingengines/vanilla/hestonexpansionengine.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down
2 changes: 1 addition & 1 deletion ql/processes/coxingersollrossprocess.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
FOR A PARTICULAR PURPOSE. See the license for more details.
*/

/*! \file coxingersollross.hpp
/*! \file coxingersollrossprocess.hpp
\brief CoxIngersollRoss process
*/

Expand Down