chore: doxy formatting

sasjs · Nov 29, 2020 · 6f86ed6 · 6f86ed6
1 parent def0cc8
commit 6f86ed6
Show file tree

Hide file tree

Showing 20 changed files with 152 additions and 184 deletions.
diff --git a/all.sas b/all.sas
diff --git a/viya/mv_createfolder.sas b/viya/mv_createfolder.sas
@@ -15,8 +15,7 @@
 
 
   @version VIYA V.03.04
-  @author Allan Bowe
-  @source https://github.com/sasjs/core
+  @author Allan Bowe, source: https://github.com/sasjs/core
 
   <h4> Dependencies </h4>
   @li mp_abort.sas
@@ -42,7 +41,7 @@
 %end;
 
 %put &sysmacroname: grant_type=&grant_type;
-%mp_abort(iftrue=(&grant_type ne authorization_code and &grant_type ne password 
+%mp_abort(iftrue=(&grant_type ne authorization_code and &grant_type ne password
     and &grant_type ne sas_services
   )
   ,mac=&sysmacroname
@@ -121,7 +120,7 @@ options noquotelenmax;
         out=&fname2
         &oauth_bearer
         url=%unquote(%superq(href));
-        headers 
+        headers
       %if &grant_type=authorization_code %then %do;
                 "Authorization"="Bearer &&&access_token_var"
       %end;

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

diff --git a/viya/mv_deletefoldermember.sas b/viya/mv_deletefoldermember.sas
@@ -1,7 +1,7 @@
 /**
   @file mv_deletefoldermember.sas
   @brief Deletes an item in a Viya folder
-  @details If not executed in Studio 5+  will expect oauth token in a global 
+  @details If not executed in Studio 5+  will expect oauth token in a global
   macro variable (default ACCESS_TOKEN).
 
       filename mc url "https://raw.githubusercontent.com/sasjs/core/main/all.sas";
@@ -20,8 +20,7 @@
 
 
   @version VIYA V.03.04
-  @author Allan Bowe
-  @source https://github.com/sasjs/core
+  @author Allan Bowe, source: https://github.com/sasjs/core
 
   <h4> Dependencies </h4>
   @li mp_abort.sas
@@ -48,7 +47,7 @@
     %let &access_token_var=;
 %end;
 %put &sysmacroname: grant_type=&grant_type;
-%mp_abort(iftrue=(&grant_type ne authorization_code and &grant_type ne password 
+%mp_abort(iftrue=(&grant_type ne authorization_code and &grant_type ne password
     and &grant_type ne sas_services
   )
   ,mac=&sysmacroname
@@ -129,7 +128,7 @@ run;
   %return;
 %end;
 proc http method="DELETE" url="&base_uri&uri" &oauth_bearer;
-  headers 
+  headers
 %if &grant_type=authorization_code %then %do;
       "Authorization"="Bearer &&&access_token_var"
 %end;

diff --git a/viya/mv_deletejes.sas b/viya/mv_deletejes.sas
@@ -1,7 +1,7 @@
 /**
   @file mv_deletejes.sas
   @brief Creates a job execution service if it does not already exist
-  @details If not executed in Studio 5+  will expect oauth token in a global 
+  @details If not executed in Studio 5+  will expect oauth token in a global
   macro variable (default ACCESS_TOKEN).
 
       filename mc url "https://raw.githubusercontent.com/sasjs/core/main/all.sas";
@@ -19,8 +19,7 @@
 
 
   @version VIYA V.03.04
-  @author Allan Bowe
-  @source https://github.com/sasjs/core
+  @author Allan Bowe, source: https://github.com/sasjs/core
 
   <h4> Dependencies </h4>
   @li mp_abort.sas
@@ -46,7 +45,7 @@
     %let &access_token_var=;
 %end;
 %put &sysmacroname: grant_type=&grant_type;
-%mp_abort(iftrue=(&grant_type ne authorization_code and &grant_type ne password 
+%mp_abort(iftrue=(&grant_type ne authorization_code and &grant_type ne password
     and &grant_type ne sas_services
   )
   ,mac=&sysmacroname
@@ -126,7 +125,7 @@ run;
   %return;
 %end;
 proc http method="DELETE" url="&uri" &oauth_bearer;
-  headers 
+  headers
 %if &grant_type=authorization_code %then %do;
       "Authorization"="Bearer &&&access_token_var"
 %end;

diff --git a/viya/mv_deleteviyafolder.sas b/viya/mv_deleteviyafolder.sas
@@ -1,7 +1,7 @@
 /**
   @file mv_deleteviyafolder.sas
   @brief Creates a viya folder if that folder does not already exist
-  @details If not running in Studo 5 +, will expect an oauth token in a global 
+  @details If not running in Studo 5 +, will expect an oauth token in a global
   macro variable (default ACCESS_TOKEN).
 
       options mprint;
@@ -16,8 +16,7 @@
 
 
   @version VIYA V.03.04
-  @author Allan Bowe
-  @source https://github.com/sasjs/core
+  @author Allan Bowe, source: https://github.com/sasjs/core
 
   <h4> Dependencies </h4>
   @li mp_abort.sas
@@ -42,7 +41,7 @@
     %let &access_token_var=;
 %end;
 %put &sysmacroname: grant_type=&grant_type;
-%mp_abort(iftrue=(&grant_type ne authorization_code and &grant_type ne password 
+%mp_abort(iftrue=(&grant_type ne authorization_code and &grant_type ne password
     and &grant_type ne sas_services
   )
   ,mac=&sysmacroname
@@ -121,10 +120,10 @@ run;
 %let fname2=%mf_getuniquefileref();
 proc http method='DELETE' out=&fname2 &oauth_bearer
     url=%unquote(%superq(href));
-    headers 
+    headers
   %if &grant_type=authorization_code %then %do;
             "Authorization"="Bearer &&&access_token_var"
-  %end;   
+  %end;
             'Accept'='*/*'; /**/
 run;
 %if &SYS_PROCHTTP_STATUS_CODE ne 204 %then %do;

diff --git a/viya/mv_getaccesstoken.sas b/viya/mv_getaccesstoken.sas
@@ -3,14 +3,13 @@
    @brief deprecated - replaced by mv_tokenrefresh.sas
 
    @version VIYA V.03.04
-   @author Allan Bowe
-   @source https://github.com/sasjs/core
- 
+   @author Allan Bowe, source: https://github.com/sasjs/core
+
    <h4> Dependencies </h4>
    @li mv_tokenrefresh.sas
 
  **/
- 
+
  %macro mv_getaccesstoken(client_id=someclient
      ,client_secret=somesecret
      ,grant_type=authorization_code

diff --git a/viya/mv_getapptoken.sas b/viya/mv_getapptoken.sas
@@ -3,14 +3,13 @@
    @brief deprecated - replaced by mv_registerclient.sas
 
    @version VIYA V.03.04
-   @author Allan Bowe
-   @source https://github.com/sasjs/core
- 
+   @author Allan Bowe, source: https://github.com/sasjs/core
+
    <h4> Dependencies </h4>
    @li mv_registerclient.sas
 
  **/
- 
+
  %macro mv_getapptoken(client_id=someclient
      ,client_secret=somesecret
      ,grant_type=authorization_code

diff --git a/viya/mv_getclients.sas b/viya/mv_getclients.sas
@@ -29,8 +29,7 @@
 
 
   @version VIYA V.03.04
-  @author Allan Bowe
-  @source https://github.com/sasjs/core
+  @author Allan Bowe, source: https://github.com/sasjs/core
 
   <h4> Dependencies </h4>
   @li mp_abort.sas
@@ -95,7 +94,7 @@ run;
 
 
 
-/* clear refs 
+/* clear refs
 filename &fname1 clear;
 libname &libref1 clear;
 */

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

diff --git a/viya/mv_getgroupmembers.sas b/viya/mv_getgroupmembers.sas
@@ -30,8 +30,7 @@
 
 
   @version VIYA V.03.04
-  @author Allan Bowe
-  @source https://github.com/sasjs/core
+  @author Allan Bowe, source: https://github.com/sasjs/core
 
   <h4> Dependencies </h4>
   @li mp_abort.sas
@@ -56,7 +55,7 @@
     %let &access_token_var=;
 %end;
 %put &sysmacroname: grant_type=&grant_type;
-%mp_abort(iftrue=(&grant_type ne authorization_code and &grant_type ne password 
+%mp_abort(iftrue=(&grant_type ne authorization_code and &grant_type ne password
     and &grant_type ne sas_services
   )
   ,mac=&sysmacroname
@@ -73,7 +72,7 @@ options noquotelenmax;
 %let fname1=%mf_getuniquefileref();
 proc http method='GET' out=&fname1 &oauth_bearer
   url="&base_uri/identities/groups/&group/members?limit=10000";
-  headers 
+  headers
   %if &grant_type=authorization_code %then %do;
           "Authorization"="Bearer &&&access_token_var"
   %end;

diff --git a/viya/mv_getgroups.sas b/viya/mv_getgroups.sas
@@ -29,8 +29,7 @@
 
 
   @version VIYA V.03.04
-  @author Allan Bowe
-  @source https://github.com/sasjs/core
+  @author Allan Bowe, source: https://github.com/sasjs/core
 
   <h4> Dependencies </h4>
   @li mp_abort.sas
@@ -54,7 +53,7 @@
     %let &access_token_var=;
 %end;
 %put &sysmacroname: grant_type=&grant_type;
-%mp_abort(iftrue=(&grant_type ne authorization_code and &grant_type ne password 
+%mp_abort(iftrue=(&grant_type ne authorization_code and &grant_type ne password
     and &grant_type ne sas_services
   )
   ,mac=&sysmacroname
@@ -72,7 +71,7 @@ options noquotelenmax;
 
 proc http method='GET' out=&fname1 &oauth_bearer
   url="&base_uri/identities/groups?limit=10000";
-  headers 
+  headers
   %if &grant_type=authorization_code %then %do;
           "Authorization"="Bearer &&&access_token_var"
   %end;

diff --git a/viya/mv_getrefreshtoken.sas b/viya/mv_getrefreshtoken.sas
@@ -3,14 +3,13 @@
    @brief deprecated - replaced by mv_tokenauth.sas
 
    @version VIYA V.03.04
-   @author Allan Bowe
-   @source https://github.com/sasjs/core
- 
+   @author Allan Bowe, source: https://github.com/sasjs/core
+
    <h4> Dependencies </h4>
    @li mv_tokenauth.sas
 
  **/
- 
+
  %macro mv_getrefreshtoken(client_id=someclient
      ,client_secret=somesecret
      ,grant_type=authorization_code

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

diff --git a/viya/mv_getusers.sas b/viya/mv_getusers.sas
@@ -34,21 +34,20 @@
       creationTimeStamp char(24),
       modifiedTimeStamp char(24),
       state char(6)
- 
+
   @param access_token_var= The global macro variable to contain the access token
   @param grant_type= valid values:
    * password
    * authorization_code
-   * detect - will check if access_token exists, if not will use sas_services if 
+   * detect - will check if access_token exists, if not will use sas_services if
     a SASStudioV session else authorization_code.  Default option.
    * sas_services - will use oauth_bearer=sas_services
 
   @param outds= The library.dataset to be created that contains the list of groups
 
 
   @version VIYA V.03.04
-  @author Allan Bowe
-  @source https://github.com/sasjs/core
+  @author Allan Bowe, source: https://github.com/sasjs/core
 
   <h4> Dependencies </h4>
   @li mp_abort.sas
@@ -72,7 +71,7 @@
     %let &access_token_var=;
 %end;
 %put &sysmacroname: grant_type=&grant_type;
-%mp_abort(iftrue=(&grant_type ne authorization_code and &grant_type ne password 
+%mp_abort(iftrue=(&grant_type ne authorization_code and &grant_type ne password
     and &grant_type ne sas_services
   )
   ,mac=&sysmacroname

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