Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-9801

Doxygen warnings in astshim

    XMLWordPrintable

    Details

    • Story Points:
      0.25
    • Sprint:
      AP S18-5
    • Team:
      Alert Production

      Description

      When building astshim with lsstsw, I got the following warning:

      lsstsw2/build/astshim/doc/mainpage.dox:41: warning: unable to resolve reference to `CmpFrame.operator' for \ref command

      This is a known bug in Doxygen 1.8.5; the workaround is to use autolinking rather than @ref.

      I also got the following warnings:

      lsstsw2/build/astshim/include/astshim/FrameSet.h:349: warning: explicit link request to 'BASE' could not be resolved

      lsstsw2/build/astshim/doc/attributes_fitsChan.dox:143: warning: unable to resolve reference to `CardType' for \ref command

      lsstsw2/build/astshim/include/astshim/Mapping.h:129: warning: Found unknown command `\refTranInverse'

      lsstsw2/build/astshim/include/astshim/Mapping.h:130: warning: unable to resolve reference to `hasTranForward' for \ref command

      lsstsw2/build/astshim/include/astshim/Mapping.h:130: warning: unable to resolve reference to `hasTranInverse' for \ref command

      lsstsw2/build/astshim/include/astshim/Mapping.h:133: warning: Found unknown command `\tranInverse'

      lsstsw2/build/astshim/include/astshim/Mapping.h:133: warning: Found unknown command `\tranForward'

        Attachments

          Issue Links

            Activity

            Hide
            rowen Russell Owen added a comment -

            I am reluctant to make astshim depend on base (though I will do that if it's necessary for astshim docs to be found). Meanwhile I set EXTRACT_ALL = YES and replaced the use of EXCLUDE_PATTERNS with EXCLUDE += src. If even EXCLUDE contaminates other packages then I'll remove that – it doesn't do any harm to let Doxygen scan the .cc files.

            Show
            rowen Russell Owen added a comment - I am reluctant to make astshim depend on base (though I will do that if it's necessary for astshim docs to be found). Meanwhile I set EXTRACT_ALL = YES and replaced the use of EXCLUDE_PATTERNS with EXCLUDE += src . If even EXCLUDE contaminates other packages then I'll remove that – it doesn't do any harm to let Doxygen scan the .cc files.
            Hide
            krzys Krzysztof Findeisen added a comment -

            Can you say why you don't want to depend on base? I thought giving all Stack packages shared settings was exactly what that package was for.

            Show
            krzys Krzysztof Findeisen added a comment - Can you say why you don't want to depend on base ? I thought giving all Stack packages shared settings was exactly what that package was for.
            Hide
            tjenness Tim Jenness added a comment -

            From my point of view, astshim could become the standard C++ wrapper for the AST library so I'd like to minimize dependencies on LSST infrastructure.

            Show
            tjenness Tim Jenness added a comment - From my point of view, astshim could become the standard C++ wrapper for the AST library so I'd like to minimize dependencies on LSST infrastructure.
            Hide
            krzys Krzysztof Findeisen added a comment -

            So astshim is not really a Stack package, and not really an external package?

            In any case, I think EXCLUDE += src will have the same side effects on full-Stack builds, but I think I came up with a config that won't clash with other packages. Feel free to merge after replacing or removing that line.

            Show
            krzys Krzysztof Findeisen added a comment - So astshim is not really a Stack package, and not really an external package? In any case, I think EXCLUDE += src will have the same side effects on full-Stack builds, but I think I came up with a config that won't clash with other packages. Feel free to merge after replacing or removing that line.
            Hide
            rowen Russell Owen added a comment -

            In my view astshim is a 3rd party package so I am reluctant to bring base in.

            As per your excellent suggestion I used EXCLUDE_PATTERNS=/astshim/src/.cc". Safe and simple. I also added a pattern for the detail subdirectory, As you said, there's no real need to hide the source; none of it causes Doxygen any problems. But I feel safer keeping it out of the source files.

            Show
            rowen Russell Owen added a comment - In my view astshim is a 3rd party package so I am reluctant to bring base in. As per your excellent suggestion I used EXCLUDE_PATTERNS= /astshim/src/ .cc" . Safe and simple. I also added a pattern for the detail subdirectory, As you said, there's no real need to hide the source; none of it causes Doxygen any problems. But I feel safer keeping it out of the source files.

              People

              Assignee:
              rowen Russell Owen
              Reporter:
              krzys Krzysztof Findeisen
              Reviewers:
              Krzysztof Findeisen
              Watchers:
              Krzysztof Findeisen, Russell Owen, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.