Creating help document for a toolbox
in [Matlab]
|
Prev: event.EventData
Next: unable to debug
From: niklas wernersson on 18 May 2010 08:12 Hello, I’ve written a fairly large toolbox containing a number of classes and functions as follows: toolbox/folderA/classA.m toolbox/folderA/functionA1.m toolbox/folderA/functionA2.m … toolbox/folderB/classB.m toolbox/folderB/functionB1.m toolbox/folderB/functionB2.m … etc. I’m now trying to create a help-document for this code and have problems in doing so. I would like to be able to write ‘doc toolbox’ in the command window and then get something like 1. Introduction text…. 2. list of folderA, folderB, etc. I would like the list of folders to be generated automatically, since the toolbox still is evolving. I would also like the folderA name to be linked such that if I click on it I get the ‘doc folderA’ command. Is there an easy way to do this? I’ve been reading some manuals but I don’t quite get how to do this. Best regards, Niklas
From: Steven Lord on 18 May 2010 09:21 "niklas wernersson" <niklas.wernersson(a)gmail.com> wrote in message news:hsu06k$59h$1(a)fred.mathworks.com... > Hello, > I’ve written a fairly large toolbox containing a number of classes > and functions as follows: > toolbox/folderA/classA.m toolbox/folderA/functionA1.m > toolbox/folderA/functionA2.m … > toolbox/folderB/classB.m toolbox/folderB/functionB1.m > toolbox/folderB/functionB2.m … > etc. > I’m now trying to create a help-document for this code and have > problems in doing so. I would like to be able to write ‘doc > toolbox’ in the command window and then get something like > 1. Introduction text…. > 2. list of folderA, folderB, etc. Read this chapter in the documentation. It tells you how to add documentation to the Help browser. http://www.mathworks.com/access/helpdesk/help/techdoc/matlab_env/bruby4n-1.html If what you're looking for instead is a Contents.m file for your directory, you can do that too. See the second row of the table at the top of that page. > I would like the list of folders to be generated automatically, since the > toolbox still is evolving. I would also like the folderA name to be linked > such that if I click on it I get the ‘doc folderA’ command. That sounds like a Contents.m file. I'm not sure it satisfies your "list of folders to be generated automatically" criterion, since what would the Contents.m include as a description of the files in your subdirectory if you didn't tell it what to include? > Is there an easy way to do this? I’ve been reading some manuals but > I don’t quite get how to do this. Follow the instructions on that page -- if you encounter difficulties while doing so, post back to the newsgroup a description of what problem you're having or contact Technical Support. -- Steve Lord slord(a)mathworks.com comp.soft-sys.matlab (CSSM) FAQ: http://matlabwiki.mathworks.com/MATLAB_FAQ
|
Pages: 1 Prev: event.EventData Next: unable to debug |