Skip to content

Commit 2d83d47

Browse files
committed
Documentation for Setting/Getting/Exporting/Importing User settings for various apps.
1 parent b144d62 commit 2d83d47

1 file changed

Lines changed: 14 additions & 3 deletions

File tree

MDX2JSON/Users.cls.xml

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<Export generator="Cache" version="25">
33
<Class name="MDX2JSON.Users">
4+
<Description><![CDATA[
5+
Class for Setting/Getting User <b>settings</b> for various <b>apps</b>.<br>
6+
Can also export/import dettings to/from <b>files</b>.]]></Description>
47
<Super>%RegisteredObject</Super>
58
<TimeCreated>63669,64053.502396</TimeCreated>
69

710
<Method name="SetConfig">
11+
<Description><![CDATA[
12+
Set <b>App</b> configuration for <b>User</b> equal to <b>Config</b>]]></Description>
813
<ClassMethod>1</ClassMethod>
914
<FormalSpec>App:%String,Config:%String,User:%String=$Username</FormalSpec>
1015
<ReturnType>%Status</ReturnType>
@@ -19,6 +24,8 @@
1924
</Method>
2025

2126
<Method name="GetConfig">
27+
<Description><![CDATA[
28+
Get <b>App</b> configuration for <b>User</b>]]></Description>
2229
<ClassMethod>1</ClassMethod>
2330
<FormalSpec>App:%String,User:%String=$Username</FormalSpec>
2431
<ReturnType>%String</ReturnType>
@@ -32,10 +39,10 @@
3239
</Method>
3340

3441
<Method name="ExportConfig">
35-
<Description>
36-
do ##class(MDX2JSON.Users).ExportConfig()</Description>
42+
<Description><![CDATA[
43+
Export <b>App</b> configuration for <b>User</b> to <b>File</b>]]></Description>
3744
<ClassMethod>1</ClassMethod>
38-
<FormalSpec>App:%String,User:%String=$Username,FileName:%String=##class(%File).TempFilename("txt")</FormalSpec>
45+
<FormalSpec>App:%String,User:%String=$Username,FileName:%String</FormalSpec>
3946
<ReturnType>%Status</ReturnType>
4047
<Implementation><![CDATA[
4148
@@ -52,6 +59,8 @@ do ##class(MDX2JSON.Users).ExportConfig()</Description>
5259
</Method>
5360

5461
<Method name="ImportConfig">
62+
<Description><![CDATA[
63+
Import <b>App</b> configuration for <b>User</b> from <b>File</b>]]></Description>
5564
<ClassMethod>1</ClassMethod>
5665
<FormalSpec>App:%String,User:%String=$Username,FileName:%String</FormalSpec>
5766
<ReturnType>%String</ReturnType>
@@ -70,6 +79,8 @@ do ##class(MDX2JSON.Users).ExportConfig()</Description>
7079
</Method>
7180

7281
<Method name="GetFavorites">
82+
<Description>
83+
Get Current user favorites</Description>
7384
<ClassMethod>1</ClassMethod>
7485
<ReturnType>%String</ReturnType>
7586
<Implementation><![CDATA[

0 commit comments

Comments
 (0)