Skip to content

Commit

Permalink
Fix Doxygen warnings
Browse files Browse the repository at this point in the history
except the ones about defaulted functions which need a bigger fix
  • Loading branch information
r-owen committed Jan 29, 2018
1 parent 8c4cdcd commit e1f6d2c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion doc/attributes_fitsChan.dox
Original file line number Diff line number Diff line change
Expand Up @@ -517,7 +517,7 @@ aberration, but ignores atmospheric refraction, polar motion, etc.
These may be added in a later release.

If an AST SkyFrame that represents offset rather than absolute
coordinates (see attribute @ref FitsChan_SkyRefIs "SkyRefIs") is written to a @ref FitsChan using
coordinates (see attribute @ref SkyFrame_SkyRefIs "SkyRefIs") is written to a @ref FitsChan using
`FITS-WCS` encoding, two alternate axis descriptions will be created.
One will describe the offset coordinates, and will use "OFLN" and
"OFLT" as the axis codes in the CTYPE keywords. The other will
Expand Down
10 changes: 5 additions & 5 deletions include/astshim/FrameDict.h
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ class FrameDict : public FrameSet {
using FrameSet::getMapping;

/**
Variant of @ref getMapping(int, int) with the second frame specified by domain.
Variant of @ref FrameSet::getMapping with the second frame specified by domain.
@throw std::out_of_range if no frame found with the specified from or to domain
*/
Expand All @@ -162,7 +162,7 @@ class FrameDict : public FrameSet {
}

/**
Variant of @ref getMapping(int, int) with the first frame specified by domain.
Variant of @ref FrameSet::getMapping with the first frame specified by domain.
@throw std::out_of_range if no frame found with the specified from or to domain
*/
Expand All @@ -171,7 +171,7 @@ class FrameDict : public FrameSet {
}

/**
Variant of @ref getMapping(int, int) with the both frames specified by domain.
Variant of @ref FrameSet::getMapping with the both frames specified by domain.
@throw std::out_of_range if no frame found with the specified from or to domain
*/
Expand Down Expand Up @@ -256,8 +256,8 @@ class FrameDict : public FrameSet {
return copyImpl<FrameDict, AstFrameSet>();
}

/*
Return a copy as a FrameSet
/**
Return a deep copy as a FrameSet
This is used internally for operations that modify the contents:
- Retrieve a copy as a FrameSet
Expand Down

0 comments on commit e1f6d2c

Please sign in to comment.