Skip to main content
hello,

I'm starting to write some 'Custom' documentation about our main subroutines, then we can receive documentation about it when hover on the name. 
So, I understand how to write the custom.json and the detail file with .md format.  yes, it works.

Well, I have a question about the organisation of my savings customs.json / *.md. 
We work with multiple account where sources are synced locally the structure is like :
.localDev
.LocalDevUtils
.LocalDevAppAccount1
.LocalDevAppAccount2

in each sub-directory of LocalDev, we have a 'vscode workspace' and we found directories :
  • .vscode
  • .rmv
  • BP
  • ...
under ..rmv we have the db.mvbasic.json file where we define parameters to login into the appAccount and relation to other account to organize 'peek defn' like 
  "catalog": {
    "isSearchAllDirs": true,
    "programDirs": [
      {"fileName": "BP"},
      {"account": "UTILS", "fileName": "BP" },
      {"account": "APP2", "fileName": "BP"}
    ]
  },

  "accounts": [
    {"name": "UTILS", "path": ".\\LocalDev\\Utils"},
    {"name": "APP2",  "path": ".\\LocalDev\\AppAccount2"}
  ]​


So, If I define a funcname into .LocalDevUtils.rmvdocumentationuniversecustom.json, when I work on workspace .LocalDevUtils , the hover show correctly my documentation. Yesss, it works.


So, If I work on workspace .LocalDevAppAccount1 , and I use a subroutine defined into UtilsBP then semantic found it, I can use Peek definition, it open it correctly. Fine !

BUT, the documentation of my Utils is not displayed when I hover the name of my subr . 

It seems, I need to copy/merge all my 'custom.json' defn on all workspace !

Is it by design or do you forget to merge db.mvbasic.json>accounts [*].../documentation at runtime ?  

Well, Yes, I can define custom.json like a 'dictionnary' of my functions and save all the .md files on a central place but it is not really easy to maintain.

do you have any sugg to optimize the behavior when multiple app use func of each other ?

with kind regards. 
manu FV



 










hello,

I'm starting to write some 'Custom' documentation about our main subroutines, then we can receive documentation about it when hover on the name. 
So, I understand how to write the custom.json and the detail file with .md format.  yes, it works.

Well, I have a question about the organisation of my savings customs.json / *.md. 
We work with multiple account where sources are synced locally the structure is like :
.localDev
.LocalDevUtils
.LocalDevAppAccount1
.LocalDevAppAccount2

in each sub-directory of LocalDev, we have a 'vscode workspace' and we found directories :
  • .vscode
  • .rmv
  • BP
  • ...
under ..rmv we have the db.mvbasic.json file where we define parameters to login into the appAccount and relation to other account to organize 'peek defn' like 
  "catalog": {
    "isSearchAllDirs": true,
    "programDirs": [
      {"fileName": "BP"},
      {"account": "UTILS", "fileName": "BP" },
      {"account": "APP2", "fileName": "BP"}
    ]
  },

  "accounts": [
    {"name": "UTILS", "path": ".\\LocalDev\\Utils"},
    {"name": "APP2",  "path": ".\\LocalDev\\AppAccount2"}
  ]​


So, If I define a funcname into .LocalDevUtils.rmvdocumentationuniversecustom.json, when I work on workspace .LocalDevUtils , the hover show correctly my documentation. Yesss, it works.


So, If I work on workspace .LocalDevAppAccount1 , and I use a subroutine defined into UtilsBP then semantic found it, I can use Peek definition, it open it correctly. Fine !

BUT, the documentation of my Utils is not displayed when I hover the name of my subr . 

It seems, I need to copy/merge all my 'custom.json' defn on all workspace !

Is it by design or do you forget to merge db.mvbasic.json>accounts [*].../documentation at runtime ?  

Well, Yes, I can define custom.json like a 'dictionnary' of my functions and save all the .md files on a central place but it is not really easy to maintain.

do you have any sugg to optimize the behavior when multiple app use func of each other ?

with kind regards. 
manu FV



 










Hi Manu,

Currently the custom documentation doesn't support cross reference in different account folders by design. We are also considering supporting such functionality recently (and how to support user profile you mentioned in another thread). We will create an enhancement ticket to track the status.

For how to support custom documentation, we are considering two solutions. The first one is, when configure some accounts in configuration file, the custom documentation in those accounts can also be involved, just like you configured in this post. Another solution is to add some user level documentation configuration file, like user profile.
If you have any suggestions or ideas, please feel free to tell us.

Thanks a lot!
hello,

I'm starting to write some 'Custom' documentation about our main subroutines, then we can receive documentation about it when hover on the name. 
So, I understand how to write the custom.json and the detail file with .md format.  yes, it works.

Well, I have a question about the organisation of my savings customs.json / *.md. 
We work with multiple account where sources are synced locally the structure is like :
.localDev
.LocalDevUtils
.LocalDevAppAccount1
.LocalDevAppAccount2

in each sub-directory of LocalDev, we have a 'vscode workspace' and we found directories :
  • .vscode
  • .rmv
  • BP
  • ...
under ..rmv we have the db.mvbasic.json file where we define parameters to login into the appAccount and relation to other account to organize 'peek defn' like 
  "catalog": {
    "isSearchAllDirs": true,
    "programDirs": [
      {"fileName": "BP"},
      {"account": "UTILS", "fileName": "BP" },
      {"account": "APP2", "fileName": "BP"}
    ]
  },

  "accounts": [
    {"name": "UTILS", "path": ".\\LocalDev\\Utils"},
    {"name": "APP2",  "path": ".\\LocalDev\\AppAccount2"}
  ]​


So, If I define a funcname into .LocalDevUtils.rmvdocumentationuniversecustom.json, when I work on workspace .LocalDevUtils , the hover show correctly my documentation. Yesss, it works.


So, If I work on workspace .LocalDevAppAccount1 , and I use a subroutine defined into UtilsBP then semantic found it, I can use Peek definition, it open it correctly. Fine !

BUT, the documentation of my Utils is not displayed when I hover the name of my subr . 

It seems, I need to copy/merge all my 'custom.json' defn on all workspace !

Is it by design or do you forget to merge db.mvbasic.json>accounts [*].../documentation at runtime ?  

Well, Yes, I can define custom.json like a 'dictionnary' of my functions and save all the .md files on a central place but it is not really easy to maintain.

do you have any sugg to optimize the behavior when multiple app use func of each other ?

with kind regards. 
manu FV



 










Hello Jingwen Li,

Yes, we are for an association of custom documentation in each 'account' environment.
The declaration of the 'accounts' just as it involves the 'Peek definition' must involve the documentation.


For info, by habit, the code documentation is in the header of the source code itself with possibly a reference to an online documentation of the wiki type.
Therefore, we write a program that will scan all cross-use subroutines and create the following files:
- custom.json {name{ brief, signature, detail}}
- name.md as pointed by custom.name.detail
- app.code-snippets to allow selection/entry help for arguments.
I will share this program soon on the forum.

I would like to suggest that custom.name.detail can refer to a file in the formats:
- LiteralLocalpathfile.md
- relativePathfile.md examples:
-- (....DOCfile.md)
-- (${workspace}DOCfile.md)
- uri http:\\serverpathfile.md format then we do not need to sync it locally.

with kind regards
manu Fernandes
hello,

I'm starting to write some 'Custom' documentation about our main subroutines, then we can receive documentation about it when hover on the name. 
So, I understand how to write the custom.json and the detail file with .md format.  yes, it works.

Well, I have a question about the organisation of my savings customs.json / *.md. 
We work with multiple account where sources are synced locally the structure is like :
.localDev
.LocalDevUtils
.LocalDevAppAccount1
.LocalDevAppAccount2

in each sub-directory of LocalDev, we have a 'vscode workspace' and we found directories :
  • .vscode
  • .rmv
  • BP
  • ...
under ..rmv we have the db.mvbasic.json file where we define parameters to login into the appAccount and relation to other account to organize 'peek defn' like 
  "catalog": {
    "isSearchAllDirs": true,
    "programDirs": [
      {"fileName": "BP"},
      {"account": "UTILS", "fileName": "BP" },
      {"account": "APP2", "fileName": "BP"}
    ]
  },

  "accounts": [
    {"name": "UTILS", "path": ".\\LocalDev\\Utils"},
    {"name": "APP2",  "path": ".\\LocalDev\\AppAccount2"}
  ]​


So, If I define a funcname into .LocalDevUtils.rmvdocumentationuniversecustom.json, when I work on workspace .LocalDevUtils , the hover show correctly my documentation. Yesss, it works.


So, If I work on workspace .LocalDevAppAccount1 , and I use a subroutine defined into UtilsBP then semantic found it, I can use Peek definition, it open it correctly. Fine !

BUT, the documentation of my Utils is not displayed when I hover the name of my subr . 

It seems, I need to copy/merge all my 'custom.json' defn on all workspace !

Is it by design or do you forget to merge db.mvbasic.json>accounts [*].../documentation at runtime ?  

Well, Yes, I can define custom.json like a 'dictionnary' of my functions and save all the .md files on a central place but it is not really easy to maintain.

do you have any sugg to optimize the behavior when multiple app use func of each other ?

with kind regards. 
manu FV



 










Hi Manu,

I think your suggestions are very good and I will discuss them with my team members. And could you share your sample mentioned in your last post?
Please feel free to contact us If you have any suggestion.

Thank you very much!
hello,

I'm starting to write some 'Custom' documentation about our main subroutines, then we can receive documentation about it when hover on the name. 
So, I understand how to write the custom.json and the detail file with .md format.  yes, it works.

Well, I have a question about the organisation of my savings customs.json / *.md. 
We work with multiple account where sources are synced locally the structure is like :
.localDev
.LocalDevUtils
.LocalDevAppAccount1
.LocalDevAppAccount2

in each sub-directory of LocalDev, we have a 'vscode workspace' and we found directories :
  • .vscode
  • .rmv
  • BP
  • ...
under ..rmv we have the db.mvbasic.json file where we define parameters to login into the appAccount and relation to other account to organize 'peek defn' like 
  "catalog": {
    "isSearchAllDirs": true,
    "programDirs": [
      {"fileName": "BP"},
      {"account": "UTILS", "fileName": "BP" },
      {"account": "APP2", "fileName": "BP"}
    ]
  },

  "accounts": [
    {"name": "UTILS", "path": ".\\LocalDev\\Utils"},
    {"name": "APP2",  "path": ".\\LocalDev\\AppAccount2"}
  ]​


So, If I define a funcname into .LocalDevUtils.rmvdocumentationuniversecustom.json, when I work on workspace .LocalDevUtils , the hover show correctly my documentation. Yesss, it works.


So, If I work on workspace .LocalDevAppAccount1 , and I use a subroutine defined into UtilsBP then semantic found it, I can use Peek definition, it open it correctly. Fine !

BUT, the documentation of my Utils is not displayed when I hover the name of my subr . 

It seems, I need to copy/merge all my 'custom.json' defn on all workspace !

Is it by design or do you forget to merge db.mvbasic.json>accounts [*].../documentation at runtime ?  

Well, Yes, I can define custom.json like a 'dictionnary' of my functions and save all the .md files on a central place but it is not really easy to maintain.

do you have any sugg to optimize the behavior when multiple app use func of each other ?

with kind regards. 
manu FV



 










hi  Jingwen Li

attached as my prog to build custom.json + subr.md + code-snippts file from source headers.

at beggining you can change the saving path and source file name ... sure you can modify to read filename from elsewhere. 

regards.
manu
Terms & ConditionsAccessibility statement