Home

NativeDoc 2 User Manual

1. Previous J Ned Selectthe HTML template that you wish to use 1 then click Next to begins the generation Adda template to the list To add an HTML Template click Add a template to the list 2 then click Open the folder and place HTML templates inside this folder Create a new template from this one Useful to create a custom template based on another one but be aware that some template have copyright restriction and that you are not allowed to modifythem Itis allowed to create custom templates from Dam pro ones Click Create a new template from this one 3 and enter the name of the new template Finally the folder where the template has been duplicated is opened Do not display handlers inside the Menu tree 4 Activates this option and inside the Menu Tree only objects will be displayed instead of objects handlers NativeDoc 2 User Manual 19 c 2007 2011 NativeSoft Damien Girard All Rights reserv ed worldwides Export errors e Y Dam pro NativeDoc Documentation Generator Generate the documentation for this project Export Errors Errors Warning met during the generation Og config stack dpconfig Line 249 A Seealso reference has been not found command_dpcLoad Aline 375 A Seealso reference has been not found command_dpcLoad Line 408 A Seealso reference has been not found command_dpcLoad 2 Line 342 A Seealso reference has been not found command_dpcLoad Line 279 A Seealso refere
2. format Include a documentation To include an external documentation inside your project documentation click Add an external documentation file 1 Then select how the external documentation should be displayed inside the documentation 2 Update an external documentation file To update an external documentation file to another one click Update and select the new XML file 3 NativeDoc 2 User Manual 12 c 2007 2011 Nativ eSoft Damien Girard All Rights reserv ed worldwides The configuration wizard HTML Template lt 2 Dam pro NativeDoc Documentation Generator HTML Template of the documentation Select the template that you wish to use O Preview Default M s ssaa anmanaaaa Default iFrame SET comman nd dpnd_Export_HTML smsiasasumawussssspunanmanaaspansa Minimalist a m _ Description Dam pro NativeDoc default iFrame template Default template using iFrame c 2009 Dam pro All rights reserved worldwide Add a template to the list N Create a new template from this one rr ta Ci Cie Select the HTML template that you wish to use 1 then click Next Add a template to the list To add an HTML Template click Add a template to the list 2 then click Open the folder and place HTML templates inside this folder Create a new template from this one Useful to create a custom template based on another one but be aware that some template hav
3. id 1 rev_NativeDoc_TextEditor stack re mi Micard id 1002 cardid1 image id SJa png image id S b png image id Potn_a button ic 3 btn_b button ic 3 btn_br button ic btn_center button ic 4 m Add a mainstack Cancel In order to makes things easier NativeDoc brings a powerful wizard that helps you to configure your documentation This screen is the first one of the wizard itenables you to select objects that you want to include inside the documentation and those that you do not wish to have in NativeDoc 2 User Manual 8 c 2007 2011 NativeSoft Damien Girard All Rights reserv ed worldwides Add a mainstack If your application have multiple mainstack simply click on Add a mainstack 1 and select the mainstack that you wish to include Exclude objects from the documentation To notinclude a substack or a card or an object 2 simply select objects that you wish to not include in the left field and click the right arrow button 3 Add only a substack To add only a substack to be documented add its mainstack and exclude all other substacks The configuration wizard analyzer configuration E lt w Dam pro NativeDoc Documentation Generator Configure the source code analyzer Not documented handlers Include not documented handlers Exclude from documentation E Do not include private functions commands F Do not include events eg on mouseup Do not include GetProp S
4. Nativesoft NativeDoc ae NativeDoc 2 User Manual c 2007 2011 NativeSoft Damien Girard All Rights reserved worldwides NativeDoc 2 User Manual 1 Introduction 1 1 Welcome to NativeDoc 2 Write documentation for your code 2 1 JavaDoc DoxyGen HTML or XML Documentation Generation 3 1 Configure the documentation with the wizard 3 2 Generate the documentation NativeDoc 2 Documentation Navigator 4 1 First contact with the Navigator 42 Refreshing the documentation 43 Add an external documentation 23 26 28 Introduction NativeDoc 2 User Manual 3 c 2007 2011 NativeSoft Damien Girard All Rights reserv ed worldwides Welcome to NativeDoc 2 Nativesoft NativeDoc x Welcome to NativeDoc 2 NativeDoc is a source code documentation tools for LiveCode Ithas been developed in focus of respecting already existing standard already available in other programming languages DoxyGen and JavaDoc in order to be easy to learn use Almost all DoxyGen and JavaDoc tutorials about the writing of documentation block are applicable to NativeDoc this documentation covers the configuration and the generation of the documentation NativeDoc 2 0 add a Dictionary Navigator that enables you to navigate through your source code documentation written using Doxygen JavaDoc tags Note about screenshot Some parts of this manual was written for NativeDoc 1 x all those screenshotare still valid for Nati
5. Suhstack Native As mentioned previously in this documentation the quick scan operation scan only saved stack but you can force the scanning of a stack Right click an elementin the tree and click Refresh Quick scan 1 This will do a quick scan operation but will force the selected stack to be rescanned NativeDoc 2 User Manual 27 c 2007 2011 NativeSoft Damien Girard All Rights reserv ed worldwides Add an external documentation Add an external documentation inside the Navigator Import manually an external documentation NativeDoc Dictiona javigato lt er E Rescan x Goto handler script L Import external documentation o rev_NativeGeometry B NativeGeometry functio raw MatiwaCanmatr Incnart r A SSE Eee Click Import external documentation then select the NativeDoc documentation XML file NativeDoc will import it automatically Remove an external documentation er Rescan x Goto handler script P Import ext D rev_NativeGeometry E o rev_nativedoc G dpnd_AddExter PU lli Go to object handler 7 s rev yMa gt Collapse all sub node mer Expand all sub node pile z rt_H Refresh Quick scan xl Remove this external documentation 4 To remove an external documentation right click on the external documentation in the tree then click Remove this externa
6. an menu Used to rescan the source code documentation 6 Go to handler script Click to select the object or to open the script editor and select the handler 7 Used to import a NativeDoc XML Documentation Note NativeDoc display by default only documented element inside the Tree itis possible to configure NativeDoc to display all elements in the menu Rescan click Rescan button to open the menu Note about the Tree Stacks displayed inside the tree are the ones displayed in the LiveCode application browser So it depends on the value of LiveCode UI Elements in Lists setting NativeDoc 2 User Manual 25 c 2007 2011 NativeSoft Damien Girard All Rights reserv ed worldwides Refreshing the documentation How to re scan your sourcecode to update the Navigation The Rescan button lt Rescan lt Go to handler script w Import external documentation El o rev_NativeGeometry a OMAN G B rev_NativeGeometry_Inspect libraryStack cor B rev_NativeGeometry_Library A NativeGenmetry isla The mostimportant button ofthe navigator is the Rescan button 1 It must be used in order to refresh the navigator documentation The Rescan menu lt e Rescan lAa Cin T Imanar etan P umentation Quick scan Analyze only updated stacks rev_NativeGec Full sco e a Omm S fur rev Native Rescan external documentation col B rev_N
7. ative gel E B rev Native Include not documented handlers x F s z rev_NativeGeometry log 7 mas s Few scan operation are available the mostused one is Quick scan 1 The Quick scan 1 The Quick scan operation will scan only updated stack file If the quick scan operation does not work simply save your stack Important The quick scan is based on the stack file modification date this means that if changes are made and the stack is not saved the quick scan will not re scan the stack The Full scan 2 Rescan all stacks either modified or not NativeDoc 2 User Manual 26 c 2007 2011 NativeSoft Damien Girard All Rights reserv ed worldwides Note If you encounter problems with the navigator perform a full scan Rescan external documentation 3 Rescan all external documentation Include not documented handlers 4 Click to enable disable the listing of all handlers inside the navigator Force the refresh of a stack Fira dq Resca Go to handler script Import external docur D rev natveseomety A aa a m rev_Nativ Go to object handler script ae rev_Natiy Q rev I Collapse all sub node Geometry B rev_Nativ rev_Nativ Expand all sub node eometry B rev_Nativ rometry_2_KeyGer Gy card id 16 Refresh Quick scan it r sInspector r wae aii aot _ ng_ClosingInspector ng_LogCallback
8. e copyright restriction and that you are not allowed to modify them Itis allowed to create custom templates from Dam pro ones Click Create a new template from this one 3 and enter the name of the new template Finally the folder where the new template has been duplicated is opened Do not display handlers inside the Menu tree 4 Activates this option and inside the Menu Tree only objects will be displayed instead of objects handlers NativeDoc 2 User Manual 13 c 2007 2011 NativeSoft Damien Girard All Rights reserv ed worldwides Ready to generate Dam pro NativeDoc Documentation Generator lt w Dam pro NativeDoc Documentation Generator Ready to generate documentation ie Dam pro NativeDoc has now all required informations to generate the documentation for your project Now simply launch the NativeDoc Documentation generator in order to generate your documentation Generate the documentation Click here to generate the documentation for this project The documentation is now ready to be generated and exported Click Generate the documentation to start the documentation and export process NativeDoc 2 User Manual 14 c 2007 2011 NativeSoft Damien Girard All Rights reserv ed worldwides Generate the documentation Analyze your application and generate the documentation Open the documentation generator w Dam pro NativeDoc Documentation Generator NativeDoc is ready to
9. e wizard NativeDoc 2 User Manual 21 c 2007 2011 NativeSoft Damien Girard All Rights reserv ed worldwides NativeDoc 2 Documentation Navigator NativeDoc 2 User Manual 22 c 2007 2011 NativeSoft Damien Girard All Rights reserv ed worldwides First contact with the Navigator Introduction to the NativeDoc Dictionary Navigator Opening the Navigator NativeDoc 2 Generate documentation gt Dictionary Navigato S Dictionary Navigator 9 Help Center About NativeDoc Simply click Dictionary Navigator NativeDoc 2 User Manual 23 c 2007 2011 Nativ eSoft Damien Girard All Rights reserv ed worldwides The Navigator gt Rescan gt Goto handler script W Import external documentation 0 rev NativeGeometry afem rev_nativedoc e NativeDoc This is the window that you obtain when you first open the Dictionary Navigator This manual is based on a real LiveCode application NativeGeometry the must have geometry manager for LiveCode At the startup of the Navigator nothing is displayed click or double click on a stack in the tree to begin NativeDoc 2 User Manual 24 c 2007 2011 NativeSoft Damien Girard All Rights reserv ed worldwides NativeDoc Dictionary lt gt Rescan T lt Go to handler scri Import external documentation sO ORE B NativeGe
10. etProp Cancel Previous The source code analyzer can be configured in orders to fit your needs Include not documented handlers 1 Display entirely your application inside the documentation including handlers not documented Do not include private functionslcommands 2 Remove all private functions commands from the documentation Do not include events eg on mouseup 3 Remove all events from the documentation NativeDoc 2 User Manual 9 c 2007 2011 Nativ eSoft Damien Girard All Rights reserv ed worldwides Warning An handler is considered as event if it begins with on instead of command Do not include GetProp SetProp 4 Remove all getprop setprop from the documentation The configuration wizard documentation information lt w Dam pro NativeDoc Documentation Generator Set informations about the documentation Project name NativeDoc Company name Dam pro Copyright c 2009 Damien Girard All rights reserved worldwide Author Damien Girard C Use a custom Main Page VW The Main page is defined E Include a Readme page 3 No Readme page defined Z Include an About page No About page defined Cancel Previous Set up the project name the company name the copyright and the author of the documentation 1 Custom pages 2 If you want to include custom pages to the documentation activate the associated button and click edit 3 to imp
11. generate documentation Generate the documentation Click here to generate the documentation for this project Configuration of the project jz3 Click here to manage the configuration of this documentation Z To open this screen click Generate the documentation inside the NativeDoc toolbar Click Generate the documentation 1 to start the documentation generation process NativeDoc 2 User Manual 15 c 2007 2011 NativeSoft Damien Girard All Rights reserv ed worldwides First step Analyzis Dam pro NativeDoc O Dam pro NativeDoc Documentation Generator Generate the documentation for this project Step 1 To generate the documentation NativeDoc have first to analyze all stacks and import external documentations Then you will be able to export the documentation in multiple format q end Startup A To start the analysis of your application click Analyze the project Analyze the project Click here to launch the analyzis of source file of this project Cancel Previous Next The first step of the generation is the analyzis of your project Click Analyze the project 1 to begin the analysis NativeDoc 2 User Manual 16 c 2007 2011 NativeSoft Damien Girard All Rights reserv ed worldwides Second step Solving analyzis errors warning Dam pro NativeDoc Docume lt 2 Dam pro NativeDoc Documentation Generator Generate the documentation for this projec
12. iveDoc handles is located inside the NativeDoc Help center 1 Before starting using NativeDoc itis really recommended to follow a Doxygen or JavaDoc tutorial in your language on google you will find easily a lot of well written one Then simply take a look at the NativeDoc documentation inside the NativeDoc help center NativeDoc is almost fully compliant with JavaDoc DoxyGen differences are marked in the help center NativeDoc 2 User Manual 6 c 2007 2011 NativeSoft Damien Girard All Rights reserv ed worldwides HTML or XML Documentation Generation NativeDoc 2 User Manual 7 c 2007 2011 NativeSoft Damien Girard All Rights reserv ed worldwides Configure the documentation with the wizard How to that describes how to configure the documentation for yours projects Select the mainstack of your project My Application Mainstack My Application w Generate documentation Help Center About NativeDoc NativeDoc stores generation parameters as custom properties inside the main stack of your project simply select a substack or the mainstack itself 1 and click Generate documentation 1 The configuration wizard objects to analyze lt w Dam pro NativeDoc Documentation Generator Select objects to analyze Objects to analyze Exclusion list e stack re o rev_NativeDoc_Library stack re G card id 1002 cardid1 card id 1002 card id1 B rev_NativeDoc_GenDoc stack re Label Field field
13. l documentation 1 Import automatically an external documentation NativeDoc can import automatically an external documentation atits startup To do so read the help of the NativeDoc command dpnd_addExternalDocumentation NativeDoc 2 User Manual 28 c 2007 2011 Nativ eSoft Damien Girard All Rights reserv ed worldwides
14. nce has been not found function_dpcRelative2Absolute h Cancel J a Next This screen display all errors warning met by the NativeDoc documentation exporter 1 To solve an error simply double click on an error warning line and your script editor will open and select the line then you have to fixthe problem WARNING Oftenly the givens line is not the line where exactly the error is but the line of the documentation block or the line of the handler Relaunch the generation Once you have fixed errors warnings click Previous 2 and relaunch the export process NativeDoc 2 User Manual 20 c 2007 2011 NativeSoft Damien Girard All Rights reserv ed worldwides Documentation Generated Dam pro NativeDoc e w Dam pro NativeDoc Documentation Generator Generate the documentation for this project Operation successful NativeDoc extracted and exported the documentation for your project Click Close NativeDoc Documentation Generator to quit this wizard or Export in another format to re export the documentation x gt Export in another format Click here to export the documentation in another format Close NativeDoc documentation generator Click here to close this wizard NativeDoc has finished to generate the documentation To export the documentation in another format click Export in another format 1 Otherwise click Close NativeDoc documentation generator 2 to close th
15. nual 17 c 2007 2011 NativeSoft Damien Girard All Rights reserv ed worldwides Third step Export the documentation Dam pro NativeDoc Docu lt p Dam pro NativeDoc Documentation Generator Generate the documentation for this project Step 3 NativeDoc extracted and generated the documentation for your project Now you have to export it Please select your export method below xx GH roras Hm Click here to generate an HTML documentation lt z gt Export as XML Click here to generate a XML file that can be used for other project Cancel Previous The documentation has been prepared and now can be exported Export the documentation as XML If you wish to re use your documentation inside another projects or you wish to re generate it later click Export as XML 1 Export the documentation as HTML To generate a documentation website click Export as HTML 2 NativeDoc 2 User Manual 18 c 2007 2011 Nativ eSoft Damien Girard All Rights reserv ed worldwides Export as HTML Select the template HTML Template of the documentation Select the template that you wish to use Default Default iFrarne Minimalist Description Dam pro NativeDoc default iFrame template Default template using iFrame c 2009 Dam pro All rights reserved worldwide Add a template to the list 3 Create a new template from this one Do not display handlers inside the Menu tree P Cancel
16. ometry _ function Returns the localized version of the serinc rev_NativeGeometry_Inspect applyNewScript command Applies the new script that the script edit rev_NativeGeometry_Library applyNewSelection command Apply the new selection a6 war MePa iese ApplyRelation command Apply currently defined relations to the o B rev_NativeGeometry_log 3 rev_NativeGeometry ScriptEditor closestack command Handle the closestack event unregister tl LZ card id 1002 closestack command Handle the closestack event free it from d sinspector closestackRequest command Handles the closeStackRequest event If p ng_ClosingInspector C GenerateRelation command Generate the graphic relation with values _ 4 ng_LogCallback m ng_Openilnspector preopenstack Stack rev_NativeGeometry e 4 RevSelectedObjectChanged w revShutDown o rev_nativedoc 4 i r Brief Entry point of NativeGeometry Plugins W NativeDoc Description 1 The Engine is located under the stack NativeGeometry w See also B NativeGeometry The screenshot show the main window of the NativeDoc Dictionary Navigator Explanation of areas 1 Tree opened stacks all documented handlers will appear here 2 List of all handlers commands functions etc available in this object and sub objects Really convenient to perform a search 3 The documentation of the selected element 4 The search bar 5 Resc
17. orts an already existing XHTML file or designs a new one NativeDoc 2 User Manual 10 c 2007 2011 NativeSoft Damien Girard All Rights reserv ed worldwides The configuration wizard custom pages editor lt hl gt About lt hl gt lt p gt Here is the about page lt br gt Documentation generated by lt b gt Damien Girard lt b gt Dam pro lt p gt The text editor enables you to define your custom page Warning The custom page must be in XHTML Strict 1 0 format If not web browsers can display your page incorrectly Buttons located in 1 helps you to design the page Open Save To open an external XHTML file click the open button 2 To save the edited text click the save button 3 Apply modifications To apply modifications press the Close button 4 NativeDoc 2 User Manual 11 c 2007 2011 NativeSoft Damien Girard All Rights reserv ed worldwides The configuration wizard includes external documentation rT lt 2 Dam pro NativeDoc Documentation Generator Include external documentation External documentation files included NativeSpeak a Properties of the external documentation Display under the Externals section Display under the Libraries section Display as part of the project Add an external documentation file Cancel J Previous NativeDoc can include external documentation stored in NativeDoc XML documentation
18. t Step 2 Errors Warning met during the analyzis bev nativedoc stack rev_nativedoc AXLine 46 Undocumented handler local t_PreopenStack_AlreadyCalled 4S Line 114 Undocumented handler on dpndWindowSetLoc pStack pLoc card id 1002 card id 1002 of stack rev_nativedoc Help field id 1034 of card id 1002 of stack rev_nativedoc Line 1 Undocumented handler on mouseenter Line 5 Undocumented handler on mouseleave GenDoc field id 1029 of card id 1002 of stack rev_nativedoc AXLine 59 Undocumented handler on mouseenter Aline 63 Undocumented handler on mouseleave About field id 1041 of card id 1002 of stack rev_nativedoc Adline 1 Undocumented handler on mouseenter lt uw h E Remove Undocumented handler warnings Cancel Previous Next This screen display all errors warning met by the NativeDoc source code analyzer 1 To solve an error simply double click on an error warning line and your script editor will open and select the line then you have to fix the problem WARNING Oftenly the givens line is not the line where exactly the error is but the line of the documentation block or the line of the handler Hiding the Undocumented handler warnings 2 Activate this button to not display warnings of type Undocumented handler Relaunch the analyzis Once you have fixed errors warnings click Previous 3 then relaunch the analysis NativeDoc 2 User Ma
19. veDoc 2 If some screenshot have marked Dam pro NativeDoc instead of NativeSoft itis normal as NativeSoft previous name was Dam pro NativeDoc 2 User Manual 4 c 2007 2011 Nativ eSoft Damien Girard All Rights reserv ed worldwides Write documentation for your code NativeDoc 2 User Manual 5 c 2007 2011 NativeSoft Damien Girard All Rights reserv ed worldwides JavaDoc DoxyGen How to write NativeDoc documentation blocks NativeDoc Help Center SS R gt Doc block guidelines NativeDoc Help Center i mj Ep User Guide Documentation block guidelines Doc block guidelines Supported Tags Commands NativeDoc has been designed to be compliant with already existing documentation tools Objects documentation block available for more traditionnal programming languages C C Java C Output customization P The main documentation block standard followed is DoxyGen some aspects of JavaDoc are Complete example available too Script Compiler This means that all tutorial lessons already written about DoxyGen are almost compliant with Chrome and IE6 NativeDoc By the way NativeDoc is not DoxyGen or JavaDoc and does not support some features of DoxyGen See the chapter What NativeDoc does not do at the end of this documentation Documentation block NativeDoc will understand all the following types of block as documentation to be extracted The list of supported block style and what Nat

NativeDoc 2 User Manual

Contents

Download Pdf Manuals

Related Search

Related Contents