DM-10146 Fix minor doc typos #8
Conversation
Add missing information about what happens to existing frame indices. I copied the AST manual, which doesn't say much, but it's better than nothing.
include/astshim/FrameSet.h
Outdated
| @@ -409,7 +409,10 @@ friend class Object; | |||
| }; | |||
|
|
|||
| /** | |||
| Remove a @ref Frame Frame from a @ref FrameSet | |||
| Remove a @ref Frame Frame from a @ref FrameSet. | |||
There was a problem hiding this comment.
These @ref tags are redundant.
There was a problem hiding this comment.
Thanks for spotting this. I changed @ref Frame Frame to @ref Frame in the only two places I found it. I would dearly love to get rid of all unnecessary @ref tags, which I think means all those that do not specify alternate text for the link, such as @ref Frame "Frames". However, I have not thought of a suitable grep expression or script. Suggestions welcome.
There was a problem hiding this comment.
I suspect the vast majority of @ref tags are unnecessary, so just searching for all of them might be faster than devising a script.
I assume you left the @ref here for forward-compatibility with such a script?
There was a problem hiding this comment.
Basically that's the case. I left it in for consistency with the rest of the documentation.
I agree that links such as @ref Frame "Frames" could probably be changed to Frames with little harm done. However, references to properties and other sorts of anchors really do benefit from having the link text specified, and there are a lot of those. Furthermore, any link that specifies link text needs more than just deleting @ref, since doing that would leave the a word followed by the desired link text behind.
Use `@anchor` instead of `@subsection` worked. Fortunately, since the Doxygen manual has this warning about `@anchor`: "Anchors can currently only be put into a comment block that is marked as a page")
|
Thanks for catching the redundant use of "Frame". I fixed that and found and fixed two other minor issues:
|
No description provided.