# Broken links in afw doxygen

XMLWordPrintable

#### Details

• Type: Bug
• Status: Done
• Resolution: Done
• Fix Version/s: None
• Component/s:
• Labels:
• Story Points:
1
• Sprint:
AP S19-4, AP S19-5, AP S19-6
• Team:

#### Description

When I build afw, I get the following warnings:

 include/lsst/afw/geom/SkyWcs.h:524: warning: unable to resolve reference to afwCameraGeomPIXELS' for \ref command include/lsst/afw/geom/SkyWcs.h:525: warning: unable to resolve reference to afwCameraGeomFIELD_ANGLE' for \ref command doc/mainpage.dox:14: warning: unable to resolve reference to afwCameraGeom' for \ref command `

I assume these are a side effect of removing some .dox files in DM-16855. Update these links so that they're valid; for example, the first two could probably be simple API links to the corresponding constants.

#### Activity

Hide
John Parejko added a comment -

Gabor Kovacs: Can you please do this small (~50 lines) review? It's mostly cleanup of doxygen links.

Show
John Parejko added a comment - Gabor Kovacs : Can you please do this small (~50 lines) review? It's mostly cleanup of doxygen links. afw PR: https://github.com/lsst/afw/pull/449 Jenkins run: https://ci.lsst.codes/blue/organizations/jenkins/stack-os-matrix/detail/stack-os-matrix/29658/pipeline
Hide
Gabor Kovacs added a comment - - edited

Looks ok, also rebased for to check for conflicts with recent changes. The doxygen site documentation pages are not built for package branches in CI, are they?

Please also consider John Swinbank's comment on github:

Where possible, please associated “TODO”s in the code with specific Jira tickets

Show
Gabor Kovacs added a comment - - edited Looks ok, also rebased for to check for conflicts with recent changes. The doxygen site documentation pages are not built for package branches in CI, are they? Please also consider John Swinbank 's comment on github: Where possible, please associated “TODO”s in the code with specific Jira tickets
Hide
Krzysztof Findeisen added a comment - - edited

Please do not rebase code changes as part of the review! That can be really confusing/disruptive to the developer. Let the PR author make any changes that are needed.

Site documentation is not built. Package-level documentation does get built, but I'm not sure how you could get at it. PRs where documentation proofreading is non-trivial sometimes attach built doc/html or doc/_build/html directories; perhaps we should have done so here.

Show
Krzysztof Findeisen added a comment - - edited Please do not rebase code changes as part of the review! That can be really confusing/disruptive to the developer. Let the PR author make any changes that are needed. Site documentation is not built. Package-level documentation does get built, but I'm not sure how you could get at it. PRs where documentation proofreading is non-trivial sometimes attach built doc/html or doc/_build/html directories; perhaps we should have done so here.
Hide
John Parejko added a comment -

Merged and done.

Show
John Parejko added a comment - Merged and done.

#### People

Assignee:
Krzysztof Findeisen
Reporter:
Krzysztof Findeisen
Reviewers:
Gabor Kovacs
Watchers:
Gabor Kovacs, John Parejko, Krzysztof Findeisen