Skip to content

Commit

Permalink
Fix clang-19 'warning: empty paragraph passed to '@throw' command [-W…
Browse files Browse the repository at this point in the history
…documentation]'

clang-19 -Wdocumentation is super pedantic and requires an explanation
for why we throw exceptions. You're so demanding clang-19! We are kind
enough to mention we throw... Doxygen doesn't even require us to justify
the circumstances in which we have to do that. Oh well, let's please you
to get peace back...
  • Loading branch information
rouault committed Oct 2, 2024
1 parent 0e2cb56 commit 8d37366
Show file tree
Hide file tree
Showing 12 changed files with 93 additions and 91 deletions.
3 changes: 2 additions & 1 deletion include/proj/coordinateoperation.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,8 @@ class PROJ_GCC_DLL CoordinateOperation : public common::ObjectUsage,
coordinateTransformer(PJ_CONTEXT *ctx) const;

/** \brief Return the inverse of the coordinate operation.
* @throw util::UnsupportedOperationException
*
* \throw util::UnsupportedOperationException if inverse is not available
*/
PROJ_DLL virtual CoordinateOperationNNPtr inverse() const = 0;

Expand Down
2 changes: 1 addition & 1 deletion include/proj/io.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -720,7 +720,7 @@ class PROJ_GCC_DLL IPROJStringExportable {
*
* @param formatter PROJ string formatter.
* @return a PROJ string.
* @throw FormattingException */
* @throw FormattingException if cannot be exported as a PROJ string */
PROJ_DLL std::string exportToPROJString(
PROJStringFormatter *formatter) const; // throw(FormattingException)

Expand Down
4 changes: 2 additions & 2 deletions src/iso19111/crs.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -5197,7 +5197,7 @@ CompoundCRS::componentReferenceSystems() PROJ_PURE_DEFN {
* At minimum the name should be defined.
* @param components the component CRS of the CompoundCRS.
* @return new CompoundCRS.
* @throw InvalidCompoundCRSException
* @throw InvalidCompoundCRSException if the object cannot be constructed.
*/
CompoundCRSNNPtr CompoundCRS::create(const util::PropertyMap &properties,
const std::vector<CRSNNPtr> &components) {
Expand Down Expand Up @@ -5299,7 +5299,7 @@ CompoundCRSNNPtr CompoundCRS::create(const util::PropertyMap &properties,
* At minimum the name should be defined.
* @param components the component CRS of the CompoundCRS.
* @return new CRS.
* @throw InvalidCompoundCRSException
* @throw InvalidCompoundCRSException if the object cannot be constructed.
*/
CRSNNPtr CompoundCRS::createLax(const util::PropertyMap &properties,
const std::vector<CRSNNPtr> &components,
Expand Down
2 changes: 1 addition & 1 deletion src/iso19111/datum.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2004,7 +2004,7 @@ void DatumEnsemble::_exportToJSON(
* @param datumsIn Array of at least 2 datums.
* @param accuracy Accuracy of the datum ensemble
* @return new DatumEnsemble.
* @throw util::Exception
* @throw util::Exception in case of error.
*/
DatumEnsembleNNPtr DatumEnsemble::create(
const util::PropertyMap &properties,
Expand Down
Loading

0 comments on commit 8d37366

Please sign in to comment.