fix: upgrading to latest doxygen

2025-12-10 22:14:35 +00:00 · 2020-11-29 13:57:44 +01:00
parent 0eccc169f5
commit 2bcf6346ac
16 changed files with 79 additions and 4113 deletions
--- a/2452
+++ b/2452
--- a/2
+++ b/2
@@ -1,4 +1,4 @@
-Copyright 2018 (Allan Bowe)
+Copyright 2020 (Allan Bowe)

 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

--- a/base/mf_abort.sas
+++ b/base/mf_abort.sas
@@ -21,7 +21,7 @@

  @version 9.2
  @author Allan Bowe
-**/
+**/  /** @cond */

 %macro mf_abort(mac=mf_abort.sas, type=, msg=, iftrue=%str(1=1)
 )/*/STORE SOURCE*/;
@@ -139,3 +139,5 @@
    %abort cancel;
  %end;
 %mend;
+
+/** @endcond */
--- a/base/mf_existfeature.sas
+++ b/base/mf_existfeature.sas
@@ -1,5 +1,5 @@
 /**
-  @file mf_existfeature.sas
+  @file
  @brief Checks whether a feature exists
  @details Check to see if a feature is supported in your environment.
    Run without arguments to see a list of detectable features.
@@ -7,10 +7,10 @@
    actual feature detection, as that is tricky / impossible to do
    without generating errors in most cases.

-      %put %mf_existfeature(PROCLUA);
+        %put %mf_existfeature(PROCLUA);

  @param feature the feature to detect.  Leave blank to list all in log.
-  
+
  @return output returns 1 or 0 (or -1 if not found)

  <h4> Dependencies </h4>
@@ -19,7 +19,7 @@

  @version 8
  @author Allan Bowe
-**/
+**/  /** @cond */

 %macro mf_existfeature(feature
 )/*/STORE SOURCE*/;
@@ -39,4 +39,6 @@
    -1
    %put &sysmacroname: &feature not found;
  %end;
-%mend;
+%mend;
+
+/** @endcond */
--- a/base/mf_existvar.sas
+++ b/base/mf_existvar.sas
@@ -11,7 +11,7 @@
  @param var (positional) - variable name
  @version 9.2
  @author Allan Bowe
-**/
+**/  /** @cond */

 %macro mf_existvar(libds /* 2 part dataset name */
      , var /* variable name */
@@ -29,4 +29,6 @@
      %let rc=%sysfunc(close(&dsid));
  %end;

-%mend;
+%mend;
+
+/** @endcond */
--- a/base/mf_getengine.sas
+++ b/base/mf_getengine.sas
@@ -22,7 +22,7 @@
  @version 9.2
  @author Allan Bowe

-**/
+**/  /** @cond */

 %macro mf_getengine(libref
 )/*/STORE SOURCE*/;
@@ -42,4 +42,6 @@

 &engine

-%mend;
+%mend;
+
+/** @endcond */
--- a/base/mf_getuniquefileref.sas
+++ b/base/mf_getuniquefileref.sas
@@ -1,17 +1,18 @@
 /**
  @file
  @brief Assigns and returns an unused fileref
-  @details Use as follows:
+  @details
+  Use as follows:

-    %let fileref1=%mf_getuniquefileref();
-    %let fileref2=%mf_getuniquefileref();
-    %put &fileref1 &fileref2;
+      %let fileref1=%mf_getuniquefileref();
+      %let fileref2=%mf_getuniquefileref();
+      %put &fileref1 &fileref2;

  which returns:

 > mcref0 mcref1

-  @prefix= first part of fileref. Remember that filerefs can only be 8
+  @param prefix= first part of fileref. Remember that filerefs can only be 8
    characters, so a 7 letter prefix would mean that `maxtries` should be 10.
  @param maxtries= the last part of the libref.  Provide an integer value.

--- a/base/mf_getuniquelibref.sas
+++ b/base/mf_getuniquelibref.sas
@@ -14,7 +14,7 @@

 > mclib3

-  @prefix= first part of libref.  Remember that librefs can only be 8 characters,
+  @param prefix= first part of libref.  Remember that librefs can only be 8 characters,
    so a 7 letter prefix would mean that maxtries should be 10.
  @param maxtries= the last part of the libref.  Provide an integer value.

--- a/doxy/Doxyfile
+++ b/doxy/Doxyfile
@@ -24,6 +24,7 @@ LAYOUT_FILE            = ./doxy/DoxygenLayout.xml
 MAX_INITIALIZER_LINES  = 0
 PROJECT_NAME           = Macro Core
 PROJECT_LOGO           = doxy/Macro_core_website_1.png
+PROJECT_BRIEF          = placeholder
 RECURSIVE              = YES
 REPEAT_BRIEF           = NO
 SHOW_NAMESPACES        = NO
--- a/doxy/DoxygenLayout.xml
+++ b/doxy/DoxygenLayout.xml
@@ -101,11 +101,11 @@
  <!-- Layout definition for a directory page -->
  <directory>
    <briefdescription visible="yes"/>
+    <detaileddescription visible="yes" title=""/>
    <directorygraph visible="yes"/>
    <memberdecl>
      <dirs visible="yes"/>
      <files visible="yes"/>
    </memberdecl>
-    <detaileddescription title=""/>
  </directory>
 </doxygenlayout>
--- a/doxy/new_footer.html
+++ b/doxy/new_footer.html
@@ -1,22 +1,23 @@
+<!-- HTML footer for doxygen 1.8.17-->
+<!-- start footer part -->
 <!--BEGIN GENERATE_TREEVIEW-->
-    <li class="footer"><b>$generatedby</b>
-    <a href="http://www.doxygen.org/index.html">
-    <img class="footer" src="doxygen.png" alt="doxygen"/></a>
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    $navpath
+    <li class="footer">$generatedby
+    <a href="https://www.doxygen.org/index.html">
+      <img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
   <i> For more information visit the </i> <a href="https://github.com/sasjs/core">Macro Core library</a>.</li>

   </ul>
 </div>
 <!--END GENERATE_TREEVIEW-->
 <!--BEGIN !GENERATE_TREEVIEW-->
-<hr class="footer"/>
-<table width="100%"><tbody><tr><td>
-For more information visit the <a href="https://github.com/sasjs/core">Macro Core library</a>.
-</td><td><address class="footer"><small>
-&copy;$year<br/>
-$generatedby <a href="http://www.doxygen.org/index.html">
-<!--<img class="footer" src="$relpath$doxygen.png" alt="doxygen"/>-->doxygen
-</a> $doxygenversion
-</small></address></tr></tbody></table>
+<hr class="footer"/><address class="footer"><small>
+  $generatedby &#160;<a href="http://www.doxygen.org/index.html">
+  <img class="footer" src="$relpath^doxygen.png" alt="doxygen"/>
+  </a> $doxygenversion
+  </small></address>
 <!--END !GENERATE_TREEVIEW-->
 </body>
 </html>
--- a/doxy/new_header.html
+++ b/doxy/new_header.html
@@ -1,6 +1,6 @@
-<!-- HTML header for doxygen 1.8.14-->
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
+<!-- HTML header for doxygen 1.8.17-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
@@ -16,51 +16,49 @@ $search
 $mathjax
 <link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
 <link REL="icon" HREF="https://sasjs.io/img/runningman.jpg">
-
 $extrastylesheet
 </head>
 <body>
 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

 <!--BEGIN TITLEAREA-->
-<div id="titlearea" style='background-color:white' >
+<div id="titlearea">
 <table cellspacing="0" cellpadding="0">
 <tbody>
- <tr style="height: 26px;">
+  <tr style="height: 56px;">
  <!--BEGIN PROJECT_LOGO-->
-  <td id="projectlogo"></td>
-
+  <td id="projectlogo">
+    <img alt="Logo" src="$relpath^$projectlogo"/></td>
  <!--END PROJECT_LOGO-->
 <!--BEGIN PROJECT_NAME-->
-  <td>
+<td id="projectalign" style="padding-left: 0.5em;">
  <div id="projectname">
-    <!--a href=".">
-      <img alt="Macro Core" src="https://macropeople.com/wp-content/uploads/2018/05/macropeople2014retina_V2.png" height=60/>
-     </a-->
-     <a href=".">
-        <img alt="Macro Core" src="./Macro_core_website_1.png" height=60/>
-       </a>
+   <!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
   </div>
+   <!--BEGIN PROJECT_BRIEF--><div id="projectbrief">
+    Production Ready Macros for SAS Application Developers</br>
+    <a href="https://github.com/sasjs/core">
+        https://github.com/sasjs/core
+    </a>
+
+   </div><!--END PROJECT_BRIEF-->
  </td>
-  <td>
+  <!--END PROJECT_NAME-->
+  <!--BEGIN !PROJECT_NAME-->
+   <!--BEGIN PROJECT_BRIEF-->
+   <td style="padding-left: 0.5em;">
+    <div id="projectbrief">$projectbrief</div>
    <table style="padding-left: 2em;" cellspacing="0" cellpadding="0">
      <tr><td> Production Ready Macros for SAS Application Developers</td></tr>
      <tr><td><a href="https://github.com/sasjs/core">
          https://github.com/sasjs/core
      </a></td></tr>
    </table>
-  </td>
-  <!--END PROJECT_NAME-->
-  <!--BEGIN !PROJECT_NAME-->
-   <!--BEGIN PROJECT_BRIEF-->
+    </td>
   <!--END PROJECT_BRIEF-->
  <!--END !PROJECT_NAME-->
-  <div class="header">
-  <div class="headertitle">
-
  <!--BEGIN DISABLE_INDEX-->
   <!--BEGIN SEARCHENGINE-->
-
   <td>$searchbox</td>
   <!--END SEARCHENGINE-->
  <!--END DISABLE_INDEX-->
--- a/doxy/new_stylesheet.css
+++ b/doxy/new_stylesheet.css
--- a/meta/mm_createlibrary.sas
+++ b/meta/mm_createlibrary.sas
@@ -9,15 +9,15 @@

  Usage:

-    %mm_createlibrary(
-       libname=My New Library
-      ,libref=mynewlib
-      ,libdesc=Super & <fine>
-      ,engine=BASE
-      ,tree=/User Folders/sasdemo
-      ,servercontext=SASApp
-      ,directory=/tmp/tests
-      ,mDebug=1)
+      %mm_createlibrary(
+        libname=My New Library
+        ,libref=mynewlib
+        ,libdesc=Super & <fine>
+        ,engine=BASE
+        ,tree=/User Folders/sasdemo
+        ,servercontext=SASApp
+        ,directory=/tmp/tests
+        ,mDebug=1)

  <h4> Dependencies </h4>
  @li mf_verifymacvars.sas
--- a/meta/mm_getstps.sas
+++ b/meta/mm_getstps.sas
@@ -23,8 +23,8 @@
    combine with the <code>tree=</code> parameter.
  @param outds= the dataset to create that contains the list of stps.
  @param mDebug= set to 1 to show debug messages in the log
-  @showDesc= provide a non blank value to return stored process descriptions
-  @showUsageVersion= provide a non blank value to return the UsageVersion.  This
+  @param showDesc= provide a non blank value to return stored process descriptions
+  @param showUsageVersion= provide a non blank value to return the UsageVersion.  This
    is either 1000000 (type 1, 9.2) or 2000000 (type2, 9.3 onwards).

  @returns outds  dataset containing the following columns
--- a/meta/mm_getwebappsrvprops.sas
+++ b/meta/mm_getwebappsrvprops.sas
@@ -1,7 +1,7 @@
 /**
  @file
  @brief Retrieves properties of the SAS web app server
-  @details 
+  @details
  Usage:

      %mm_getwebappsrvprops(outds= some_ds)
@@ -21,8 +21,7 @@
      libname __shake clear;

  @version 9.4
-  @author Allan Bowe
-  @source https://github.com/sasjs/core
+  @author Allan Bowe https://github.com/sasjs/core

 **/