Hi,

On 2020-02-05 15:04, Gordon, Craig A. (GSFC-660.1)[INNOVIM] wrote:
> Hi Paolo,
> 
> It was never intended for end users to have to generate the CCfits manual 
> themselves (nor is it intended to be compatible with all versions of 
> Doxygen).  That's why CCfits-2.5.pdf is included with the stand-alone 
> distribution.  Is there a special reason you're trying to run "make docs"?  
> Because otherwise I wouldn't recommend doing that.

In Debian we have a rule requiring that everything, including
documentation, is rebuild from sources.

I have finally been able to build the documentation with the attached
patch. It fixes two issues:
- Newer versions of doxygen now interpret "<U>" in "KeyData<U>" as an
  the underline HTML command. The patch escapes it so that it is not
  interpreted anymore.
- Newer versions of doxygen have markdown support enabled by default,
  causing indented lines to be interpreted as the verbatim code.

Best regards,
Aurelien Jarno

-- 
Aurelien Jarno                          GPG: 4096R/1DDD8C9B
aurel...@aurel32.net                 http://www.aurel32.net
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -1758,3 +1758,13 @@ GENERATE_LEGEND        = YES
 # the various graphs.
 
 DOT_CLEANUP            = YES
+
+# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
+# according to the Markdown format, which allows for more readable
+# documentation. See https://daringfireball.net/projects/markdown/ for details.
+# The output of markdown processing is further processed by doxygen, so you can
+# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
+# case of backward compatibilities issues.
+
+MARKDOWN_SUPPORT       = NO
+
--- a/Keyword.h
+++ b/Keyword.h
@@ -155,7 +155,7 @@ namespace CCfits {
        \param val (T) Will be filled with the keyword value, and is also the function return value.
 
        <b>Allowed T types:</b> CCfits stores keyword values of type U in a templated subclass of
-       Keyword, <b>KeyData<U></b>.  Normally U is set when reading the Keyword in from the file, 
+       Keyword, <b>KeyData\<U\></b>.  Normally U is set when reading the Keyword in from the file, 
        and is limited to types int, double, string, bool, and complex<float>.
        (The exception is when the user has created and added a new Keyword using an
        HDU::addKey function, in which case they might have specified other types for U.)  
@@ -180,7 +180,7 @@ namespace CCfits {
        \param newValue (T) New value for the Keyword
 
        <b>Allowed T types:</b> This must copy <i>newValue</i> to a data member of type U in the
-       Keyword subclass <b>KeyData<U></b> (see description for Keyword::value (T& val) for more
+       Keyword subclass <b>KeyData\<U\></b> (see description for Keyword::value (T& val) for more
        details).  To avoid compilation errors, it is generally best to provide a <i>newValue</i>
        of type T = type U, though the following type conversions will also be handled:
 

Attachment: signature.asc
Description: PGP signature

Reply via email to