1
0
mirror of https://github.com/sasjs/core.git synced 2026-01-15 20:40:05 +00:00

chore: doxy formatting

This commit is contained in:
2020-11-29 22:03:20 +01:00
parent def0cc8476
commit 6f86ed62a2
20 changed files with 152 additions and 184 deletions

94
all.sas
View File

@@ -10329,8 +10329,7 @@ run;
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas
@@ -10467,27 +10466,28 @@ options noquotelenmax;
%mend;/** %mend;/**
@file mv_createwebservice.sas @file mv_createwebservice.sas
@brief Creates a JobExecution web service if it doesn't already exist @brief Creates a JobExecution web service if it doesn't already exist
@details Code is passed in as one or more filerefs. @details
Code is passed in as one or more filerefs.
%* Step 1 - compile macros ; %* Step 1 - compile macros ;
filename mc url "https://raw.githubusercontent.com/sasjs/core/main/all.sas"; filename mc url "https://raw.githubusercontent.com/sasjs/core/main/all.sas";
%inc mc; %inc mc;
%* Step 2 - Create some code and add it to a web service; %* Step 2 - Create some code and add it to a web service;
filename ft15f001 temp; filename ft15f001 temp;
parmcards4; parmcards4;
%webout(FETCH) %* fetch any tables sent from frontend; %webout(FETCH) %* fetch any tables sent from frontend;
%* do some sas, any inputs are now already WORK tables; %* do some sas, any inputs are now already WORK tables;
data example1 example2; data example1 example2;
set sashelp.class; set sashelp.class;
run; run;
%* send data back; %* send data back;
%webout(OPEN) %webout(OPEN)
%webout(ARR,example1) * Array format, fast, suitable for large tables ; %webout(ARR,example1) * Array format, fast, suitable for large tables ;
%webout(OBJ,example2) * Object format, easier to work with ; %webout(OBJ,example2) * Object format, easier to work with ;
%webout(CLOSE) %webout(CLOSE)
;;;; ;;;;
%mv_createwebservice(path=/Public/app/common,name=appinit) %mv_createwebservice(path=/Public/app/common,name=appinit)
Notes: Notes:
@@ -10520,8 +10520,7 @@ options noquotelenmax;
a shared context - see https://go.documentation.sas.com/?docsetId=calcontexts&docsetTarget=n1hjn8eobk5pyhn1wg3ja0drdl6h.htm&docsetVersion=3.5&locale=en a shared context - see https://go.documentation.sas.com/?docsetId=calcontexts&docsetTarget=n1hjn8eobk5pyhn1wg3ja0drdl6h.htm&docsetVersion=3.5&locale=en
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
**/ **/
@@ -11143,8 +11142,7 @@ run;
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas
@@ -11293,8 +11291,7 @@ libname &libref1a clear;
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas
@@ -11438,8 +11435,7 @@ libname &libref1a clear;
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas
@@ -11567,8 +11563,7 @@ libname &libref1 clear;
@brief deprecated - replaced by mv_tokenrefresh.sas @brief deprecated - replaced by mv_tokenrefresh.sas
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mv_tokenrefresh.sas @li mv_tokenrefresh.sas
@@ -11599,8 +11594,7 @@ libname &libref1 clear;
@brief deprecated - replaced by mv_registerclient.sas @brief deprecated - replaced by mv_registerclient.sas
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mv_registerclient.sas @li mv_registerclient.sas
@@ -11648,8 +11642,7 @@ libname &libref1 clear;
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas
@@ -11735,8 +11728,7 @@ libname &libref1 clear;
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas
@@ -11869,8 +11861,7 @@ libname &libref1 clear;
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas
@@ -11974,8 +11965,7 @@ filename &fname1 clear;
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas
@@ -12045,8 +12035,7 @@ libname &libref1 clear;
@brief deprecated - replaced by mv_tokenauth.sas @brief deprecated - replaced by mv_tokenauth.sas
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mv_tokenauth.sas @li mv_tokenauth.sas
@@ -12095,8 +12084,7 @@ libname &libref1 clear;
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas
@@ -12214,8 +12202,7 @@ libname &libref1 clear;
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas
@@ -12301,7 +12288,7 @@ libname &libref1 clear;
Example with parameters: Example with parameters:
%mv_jobexecute(path=/Public/folder %mv_jobexecute(path=/Public/folder
,name=somejob ,name=somejob
,paramstring=%str("macvarname":"macvarvalue","answer":42) ,paramstring=%str("macvarname":"macvarvalue","answer":42)
) )
@@ -12502,8 +12489,7 @@ libname &libref;
for debugging. Default= _null_. for debugging. Default= _null_.
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas
@@ -12726,8 +12712,7 @@ libname &libref clear;
@param base_uri= The Viya API server location @param base_uri= The Viya API server location
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas
@@ -12869,8 +12854,7 @@ filename &fref2 clear;
@param refresh_token_var= The global macro variable containing the refresh token @param refresh_token_var= The global macro variable containing the refresh token
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas
@@ -12992,7 +12976,7 @@ filename &fref1 clear;
@li mf_getuser.sas @li mf_getuser.sas
@version Viya 3.3 @version Viya 3.3
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
**/ **/
%macro mv_webout(action,ds,fref=_mvwtemp,dslabel=,fmt=Y); %macro mv_webout(action,ds,fref=_mvwtemp,dslabel=,fmt=Y);

View File

@@ -15,8 +15,7 @@
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas

View File

@@ -1,27 +1,28 @@
/** /**
@file mv_createwebservice.sas @file mv_createwebservice.sas
@brief Creates a JobExecution web service if it doesn't already exist @brief Creates a JobExecution web service if it doesn't already exist
@details Code is passed in as one or more filerefs. @details
Code is passed in as one or more filerefs.
%* Step 1 - compile macros ; %* Step 1 - compile macros ;
filename mc url "https://raw.githubusercontent.com/sasjs/core/main/all.sas"; filename mc url "https://raw.githubusercontent.com/sasjs/core/main/all.sas";
%inc mc; %inc mc;
%* Step 2 - Create some code and add it to a web service; %* Step 2 - Create some code and add it to a web service;
filename ft15f001 temp; filename ft15f001 temp;
parmcards4; parmcards4;
%webout(FETCH) %* fetch any tables sent from frontend; %webout(FETCH) %* fetch any tables sent from frontend;
%* do some sas, any inputs are now already WORK tables; %* do some sas, any inputs are now already WORK tables;
data example1 example2; data example1 example2;
set sashelp.class; set sashelp.class;
run; run;
%* send data back; %* send data back;
%webout(OPEN) %webout(OPEN)
%webout(ARR,example1) * Array format, fast, suitable for large tables ; %webout(ARR,example1) * Array format, fast, suitable for large tables ;
%webout(OBJ,example2) * Object format, easier to work with ; %webout(OBJ,example2) * Object format, easier to work with ;
%webout(CLOSE) %webout(CLOSE)
;;;; ;;;;
%mv_createwebservice(path=/Public/app/common,name=appinit) %mv_createwebservice(path=/Public/app/common,name=appinit)
Notes: Notes:
@@ -54,8 +55,7 @@
a shared context - see https://go.documentation.sas.com/?docsetId=calcontexts&docsetTarget=n1hjn8eobk5pyhn1wg3ja0drdl6h.htm&docsetVersion=3.5&locale=en a shared context - see https://go.documentation.sas.com/?docsetId=calcontexts&docsetTarget=n1hjn8eobk5pyhn1wg3ja0drdl6h.htm&docsetVersion=3.5&locale=en
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
**/ **/

View File

@@ -20,8 +20,7 @@
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas

View File

@@ -19,8 +19,7 @@
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas

View File

@@ -16,8 +16,7 @@
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas

View File

@@ -3,8 +3,7 @@
@brief deprecated - replaced by mv_tokenrefresh.sas @brief deprecated - replaced by mv_tokenrefresh.sas
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mv_tokenrefresh.sas @li mv_tokenrefresh.sas

View File

@@ -3,8 +3,7 @@
@brief deprecated - replaced by mv_registerclient.sas @brief deprecated - replaced by mv_registerclient.sas
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mv_registerclient.sas @li mv_registerclient.sas

View File

@@ -29,8 +29,7 @@
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas

View File

@@ -15,8 +15,7 @@
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas

View File

@@ -30,8 +30,7 @@
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas

View File

@@ -29,8 +29,7 @@
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas

View File

@@ -3,8 +3,7 @@
@brief deprecated - replaced by mv_tokenauth.sas @brief deprecated - replaced by mv_tokenauth.sas
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mv_tokenauth.sas @li mv_tokenauth.sas

View File

@@ -20,8 +20,7 @@
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas

View File

@@ -47,8 +47,7 @@
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas

View File

@@ -18,7 +18,7 @@
Example with parameters: Example with parameters:
%mv_jobexecute(path=/Public/folder %mv_jobexecute(path=/Public/folder
,name=somejob ,name=somejob
,paramstring=%str("macvarname":"macvarvalue","answer":42) ,paramstring=%str("macvarname":"macvarvalue","answer":42)
) )

View File

@@ -52,8 +52,7 @@
for debugging. Default= _null_. for debugging. Default= _null_.
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas

View File

@@ -41,8 +41,7 @@
@param base_uri= The Viya API server location @param base_uri= The Viya API server location
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas

View File

@@ -40,8 +40,7 @@
@param refresh_token_var= The global macro variable containing the refresh token @param refresh_token_var= The global macro variable containing the refresh token
@version VIYA V.03.04 @version VIYA V.03.04
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
@source https://github.com/sasjs/core
<h4> Dependencies </h4> <h4> Dependencies </h4>
@li mp_abort.sas @li mp_abort.sas

View File

@@ -32,7 +32,7 @@
@li mf_getuser.sas @li mf_getuser.sas
@version Viya 3.3 @version Viya 3.3
@author Allan Bowe @author Allan Bowe, source: https://github.com/sasjs/core
**/ **/
%macro mv_webout(action,ds,fref=_mvwtemp,dslabel=,fmt=Y); %macro mv_webout(action,ds,fref=_mvwtemp,dslabel=,fmt=Y);