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

Add standard library tag file to Doxygen

    XMLWordPrintable

    Details

    • Story Points:
      1
    • Sprint:
      Alert Production F17 - 9, Alert Production F17 - 10
    • Team:
      Alert Production

      Description

      cppreference.com provides a tag file that allows Doxygen builds to link to its documentation on standard library types (vector, string, standard exception classes, etc.). Using this file in lsst.base would save developers working with Stack code from having to look up these classes by hand. A minor feature, but a convenient one.

      One question that would need to be addressed is whether the tag file should be stored in base or downloaded from the website each time. The former is easier (and allows documentation to be built without an internet connection), while the latter would prevent the tag file from going out of date.

        Attachments

          Issue Links

            Activity

            Hide
            krzys Krzysztof Findeisen added a comment -

            Jonathan Sick, can you please review this change to how Doxygen config files are built by Scons?

            Contrary to the issue description, the tag file was registered in code rather than in base.inc because I could not get Doxygen to find it without an absolute path. Placing the file itself in sconsUtils was suggested by Paul Price on #dm as a way to avoid a circular dependency between sconsUtils and base.

            Show
            krzys Krzysztof Findeisen added a comment - Jonathan Sick , can you please review this change to how Doxygen config files are built by Scons? Contrary to the issue description, the tag file was registered in code rather than in base.inc because I could not get Doxygen to find it without an absolute path. Placing the file itself in sconsUtils was suggested by Paul Price on #dm as a way to avoid a circular dependency between sconsUtils and base .
            Hide
            jsick Jonathan Sick added a comment -

            Hi Krzysztof Findeisen, I don't think I can give a useful review. Could you find someone else who's knowledgeable about sconsUtils and who regularly uses the Doxygen tooling to review this?

            Show
            jsick Jonathan Sick added a comment - Hi Krzysztof Findeisen , I don't think I can give a useful review. Could you find someone else who's knowledgeable about sconsUtils and who regularly uses the Doxygen tooling to review this?
            Hide
            krzys Krzysztof Findeisen added a comment -

            PR withdrawn after Tim Jenness found a less hacky implementation.

            Show
            krzys Krzysztof Findeisen added a comment - PR withdrawn after Tim Jenness found a less hacky implementation.
            Hide
            krughoff Simon Krughoff added a comment -

            Just to be clear, Krzysztof Findeisen, you'll give this to Tim Jenness to review when you have the fixe to base, right?

            Show
            krughoff Simon Krughoff added a comment - Just to be clear, Krzysztof Findeisen , you'll give this to Tim Jenness to review when you have the fixe to base , right?
            Hide
            krzys Krzysztof Findeisen added a comment -

            I can, sure.

            Show
            krzys Krzysztof Findeisen added a comment - I can, sure.
            Hide
            krzys Krzysztof Findeisen added a comment -

            Hi Tim Jenness, can you take a look at the new solution? The tag file itself is handled purely in base/Doxygen now, but I've kept the fix to sconsUtils accidentally clobbering its own TAGFILES += lines.

            Show
            krzys Krzysztof Findeisen added a comment - Hi Tim Jenness , can you take a look at the new solution? The tag file itself is handled purely in base /Doxygen now, but I've kept the fix to sconsUtils accidentally clobbering its own TAGFILES += lines.
            Hide
            tjenness Tim Jenness added a comment -

            Looks good. Thanks.

            Show
            tjenness Tim Jenness added a comment - Looks good. Thanks.

              People

              Assignee:
              krzys Krzysztof Findeisen
              Reporter:
              krzys Krzysztof Findeisen
              Reviewers:
              Tim Jenness
              Watchers:
              Jonathan Sick, Krzysztof Findeisen, Simon Krughoff, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.