From 58bfc7b4aac5d8f3f747d44a27b3abffbecc095e Mon Sep 17 00:00:00 2001 From: Allan Bowe Date: Mon, 1 Mar 2021 17:48:44 +0100 Subject: [PATCH] chore: updating doxy formatting to include folder descriptions, also updating headers for some macros --- sasjs/doxy/Doxyfile | 2 +- sasjs/doxy/DoxygenLayout.xml | 1 - sasjs/sasjsconfig.json | 2 +- sasjs/utils/build.sh | 2 ++ viya/mv_getgroups.sas | 23 ++++++----------------- 5 files changed, 10 insertions(+), 20 deletions(-) diff --git a/sasjs/doxy/Doxyfile b/sasjs/doxy/Doxyfile index eea79b4..1ea8e28 100644 --- a/sasjs/doxy/Doxyfile +++ b/sasjs/doxy/Doxyfile @@ -20,7 +20,7 @@ HTML_EXTRA_STYLESHEET = $(DOXY_CONTENT)new_stylesheet.css INHERIT_DOCS = NO INLINE_INFO = NO INPUT = $(DOXY_CONTENT)../../README.md \ - $(DOXY_CONTENT)../../CONTRIBUTING.md \ + = $(DOXY_CONTENT)../../main.dox \ $(DOXY_INPUT) USE_MDFILE_AS_MAINPAGE = README.md LAYOUT_FILE = $(DOXY_CONTENT)DoxygenLayout.xml diff --git a/sasjs/doxy/DoxygenLayout.xml b/sasjs/doxy/DoxygenLayout.xml index 4be2bb0..3d18413 100644 --- a/sasjs/doxy/DoxygenLayout.xml +++ b/sasjs/doxy/DoxygenLayout.xml @@ -3,7 +3,6 @@ - diff --git a/sasjs/sasjsconfig.json b/sasjs/sasjsconfig.json index b4f24c6..2f7e27b 100644 --- a/sasjs/sasjsconfig.json +++ b/sasjs/sasjsconfig.json @@ -1,6 +1,6 @@ { "$schema": "https://cli.sasjs.io/sasjsconfig-schema.json", - "macroFolders": ["../base", "../meta", "../metax", "../viya", "../lua"], + "macroFolders": ["base", "meta", "metax", "viya", "lua"], "docConfig":{ "displayMacroCore": false } diff --git a/sasjs/utils/build.sh b/sasjs/utils/build.sh index 84975f5..4a1f77d 100755 --- a/sasjs/utils/build.sh +++ b/sasjs/utils/build.sh @@ -3,6 +3,8 @@ # PROJECT: Macro Core Docs Build # #################################################################### +cd ../.. + sasjs doc # refresh github pages site diff --git a/viya/mv_getgroups.sas b/viya/mv_getgroups.sas index b292d40..03ef87a 100644 --- a/viya/mv_getgroups.sas +++ b/viya/mv_getgroups.sas @@ -1,31 +1,20 @@ /** @file mv_getgroups.sas @brief Creates a dataset with a list of viya groups - @details First, be sure you have an access token (which requires an app token). - - Using the macros here: + @details First, load the macros: filename mc url "https://raw.githubusercontent.com/sasjs/core/main/all.sas"; %inc mc; - An administrator needs to set you up with an access code: + Next, execute: - %mv_registerclient(outds=client) + %mv_getgroups(outds=work.groups) - Navigate to the url from the log (opting in to the groups) and paste the - access code below: - - %mv_tokenauth(inds=client,code=wKDZYTEPK6) - - Now we can run the macro! - - %mv_getgroups() - - @param access_token_var= The global macro variable to contain the access token - @param grant_type= valid values are "password" or "authorization_code" (unquoted). + @param [in] access_token_var= The global macro variable to contain the access token + @param [in] grant_type= valid values are "password" or "authorization_code" (unquoted). The default is authorization_code. - @param outds= The library.dataset to be created that contains the list of groups + @param [out] outds= The library.dataset to be created that contains the list of groups @version VIYA V.03.04