Merge pull request #6 from sasjs/sasjsdoc

initial commit
2026-01-05 00:20:05 +00:00 · 2021-02-04 15:48:20 +02:00
parent 8d64b30419 fbd8196230
commit e38f331ad5
16 changed files with 182 additions and 112 deletions
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,3 @@
 node_modules
-.DS_Store
+.DS_Store
+sasjsbuild/
--- a/doxy/new_footer.html
+++ b/doxy/new_footer.html
@@ -1,23 +0,0 @@
-<!-- HTML footer for doxygen 1.8.17-->
-<!-- start footer part -->
-<!--BEGIN GENERATE_TREEVIEW-->
-<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"/><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,72 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!-- HTML header for doxygen 1.8.17-->
-<html xmlns="https://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"/>
-<meta name="generator" content="Doxygen $doxygenversion"/>
-<meta name="viewport" content="width=device-width, initial-scale=1"/>
-<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
-<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
-<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
-<script type="text/javascript" src="$relpath^jquery.js"></script>
-<script type="text/javascript" src="$relpath^dynsections.js"></script>
-$treeview
-$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">
-<table cellspacing="0" cellpadding="0">
- <tbody>
-  <tr style="height: 56px;">
-  <!--BEGIN PROJECT_LOGO-->
-  <td id="projectlogo">
-    <img alt="Logo" src="$relpath^$projectlogo"/></td>
-  <!--END PROJECT_LOGO-->
-<!--BEGIN PROJECT_NAME-->
-<td id="projectalign" style="padding-left: 0.5em;">
-  <div id="projectname">
-   <!--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>
-   <meta name="Description" content="$projectbrief">
-   <!--END PROJECT_BRIEF-->
-  </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_BRIEF-->
-  <!--END !PROJECT_NAME-->
-  <!--BEGIN DISABLE_INDEX-->
-   <!--BEGIN SEARCHENGINE-->
-   <td>$searchbox</td>
-   <!--END SEARCHENGINE-->
-  <!--END DISABLE_INDEX-->
- </tr>
- </tbody>
-</table>
-</div>
-<!--END TITLEAREA-->
-<!-- end header part -->
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,4 +1,28 @@
 {
-  "name": "macrocore",
-  "lockfileVersion": 1
+  "name": "@sasjs/core",
+  "version": "1.0.0",
+  "lockfileVersion": 2,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "@sasjs/core",
+      "version": "1.0.0",
+      "license": "MIT",
+      "dependencies": {
+        "@sasjs/core": "^2.2.1"
+      }
+    },
+    "node_modules/@sasjs/core": {
+      "version": "2.2.1",
+      "resolved": "https://registry.npmjs.org/@sasjs/core/-/core-2.2.1.tgz",
+      "integrity": "sha512-CLICF0+ZUorKXct+4eU4ij1D5JCt4FZLwIyrUmfIA55XZJZxerS8pffh8BvXNi0x8MvtfKM12MCrpbtWTaX+Mw=="
+    }
+  },
+  "dependencies": {
+    "@sasjs/core": {
+      "version": "2.2.1",
+      "resolved": "https://registry.npmjs.org/@sasjs/core/-/core-2.2.1.tgz",
+      "integrity": "sha512-CLICF0+ZUorKXct+4eU4ij1D5JCt4FZLwIyrUmfIA55XZJZxerS8pffh8BvXNi0x8MvtfKM12MCrpbtWTaX+Mw=="
+    }
+  }
 }
--- a/package.json
+++ b/package.json
@@ -10,13 +10,25 @@
  "author": "Allan Bowe <support@macropeople.com>",
  "repository": {
    "type": "git",
-    "url": "https://github.com/sasjs/core"
+    "url": "git+https://github.com/sasjs/core.git"
  },
  "release": {
-    "branches": ["main"]
+    "branches": [
+      "main"
+    ]
  },
  "publishConfig": {
    "access": "public"
  },
-  "devDependencies": {}
+  "bugs": {
+    "url": "https://github.com/sasjs/core/issues"
+  },
+  "homepage": "https://github.com/sasjs/core#readme",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+  }
 }
--- a/sasjs/doxy/Doxyfile
+++ b/sasjs/doxy/Doxyfile
@@ -13,17 +13,17 @@ HIDE_IN_BODY_DOCS      = YES
 HIDE_SCOPE_NAMES       = YES
 HIDE_UNDOC_CLASSES     = YES
 HIDE_UNDOC_MEMBERS     = YES
-HTML_OUTPUT            = doxy
-HTML_HEADER            = ./doxy/new_header.html
-HTML_FOOTER            = ./doxy/new_footer.html
-HTML_EXTRA_STYLESHEET  = ./doxy/new_stylesheet.css
+HTML_OUTPUT            = $(DOXY_HTML_OUTPUT)
+HTML_HEADER            = $(DOXY_CONTENT)new_header.html
+HTML_FOOTER            = $(DOXY_CONTENT)new_footer.html
+HTML_EXTRA_STYLESHEET  = $(DOXY_CONTENT)new_stylesheet.css
 INHERIT_DOCS           = NO
 INLINE_INFO            = NO
-INPUT                  = base meta metax viya lua
-LAYOUT_FILE            = ./doxy/DoxygenLayout.xml
+INPUT                  = $(DOXY_INPUT)
+LAYOUT_FILE            = $(DOXY_CONTENT)DoxygenLayout.xml
 MAX_INITIALIZER_LINES  = 0
 PROJECT_NAME           = Macro Core
-PROJECT_LOGO           = doxy/Macro_core_website_1.png
+PROJECT_LOGO           = $(DOXY_CONTENT)Macro_core_website_1.png
 PROJECT_BRIEF          = "Production Ready Macros for SAS Application Developers"
 RECURSIVE              = YES
 REPEAT_BRIEF           = NO
--- a/sasjs/doxy/DoxygenLayout.xml
+++ b/sasjs/doxy/DoxygenLayout.xml
--- a/sasjs/doxy/Macro_core_website_1.png
+++ b/sasjs/doxy/Macro_core_website_1.png
--- a/sasjs/doxy/batch.bat
+++ b/sasjs/doxy/batch.bat
--- a/sasjs/doxy/build.sh
+++ b/sasjs/doxy/build.sh
--- a/sasjs/doxy/favicon.ico
+++ b/sasjs/doxy/favicon.ico
--- a/sasjs/doxy/new_footer.html
+++ b/sasjs/doxy/new_footer.html
@@ -0,0 +1,32 @@
+<!-- HTML footer for doxygen 1.8.17-->
+<!-- start footer part -->
+<!--BEGIN GENERATE_TREEVIEW-->
+<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>
+    <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" />
+<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-->
--- a/sasjs/doxy/new_header.html
+++ b/sasjs/doxy/new_header.html
@@ -0,0 +1,93 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!-- HTML header for doxygen 1.8.17-->
+<html xmlns="https://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" />
+    <meta name="generator" content="Doxygen $doxygenversion" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <!--BEGIN PROJECT_NAME-->
+    <title>$projectname: $title</title>
+    <!--END PROJECT_NAME-->
+    <!--BEGIN !PROJECT_NAME-->
+    <title>$title</title>
+    <!--END !PROJECT_NAME-->
+    <link href="$relpath^tabs.css" rel="stylesheet" type="text/css" />
+    <script type="text/javascript" src="$relpath^jquery.js"></script>
+    <script type="text/javascript" src="$relpath^dynsections.js"></script>
+    $treeview $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">
+        <table cellspacing="0" cellpadding="0">
+          <tbody>
+            <tr style="height: 56px">
+              <!--BEGIN PROJECT_LOGO-->
+              <td id="projectlogo">
+                <img alt="Logo" src="$relpath^$projectlogo" />
+              </td>
+              <!--END PROJECT_LOGO-->
+              <!--BEGIN PROJECT_NAME-->
+              <td id="projectalign" style="padding-left: 0.5em">
+                <div id="projectname">
+                  <!--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>
+                <meta name="Description" content="$projectbrief" />
+                <!--END PROJECT_BRIEF-->
+              </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_BRIEF-->
+              <!--END !PROJECT_NAME-->
+              <!--BEGIN DISABLE_INDEX-->
+              <!--BEGIN SEARCHENGINE-->
+              <td>$searchbox</td>
+              <!--END SEARCHENGINE-->
+              <!--END DISABLE_INDEX-->
+            </tr>
+          </tbody>
+        </table>
+      </div>
+      <!--END TITLEAREA-->
+      <!-- end header part -->
+    </div>
+  </body>
+</html>
--- a/sasjs/doxy/new_stylesheet.css
+++ b/sasjs/doxy/new_stylesheet.css
@@ -1,5 +1,5 @@
-#projectlogo img
-{
-	border: 0px none;
-	max-height:70px
+#projectlogo img
+{
+	border: 0px none;
+	max-height:70px
 }
--- a/sasjs/doxy/runningman.jpg
+++ b/sasjs/doxy/runningman.jpg
--- a/sasjs/sasjsconfig.json
+++ b/sasjs/sasjsconfig.json
@@ -0,0 +1,3 @@
+{
+  "macroFolders": ["../base", "../meta", "../metax", "../viya", "../lua"]
+}