EDoc Application
Contents
1. hh h This is the second paragraph The above line is hh regarded as empty by EDoc even though it ends with hh a Space will generate the following text This will all be part of the first paragraph It can stretch over several lines and contain any XHTML markup Thisis the second paragraph The above line is regarded as empty by EDoc even though it ends with a space Paragraph splitting takes place after the actual X HTML parsing It only affects block level text and not e g text within lt pre gt markup or text that is already within lt p gt markup 1URL http en wikipedia org wiki Wiki 8 EDoc Application 1 1 Welcome to EDoc Headings Section headings sub headings and sub sub headings can be written using the following notation Heading Sub heading Sub sub heading Such aheading must be alone on aline except for whitespace and cannot be split over several lines A link target is automatically created for the heading by replacing any whitespace within the text by a single underscore character E g Concerning Hobbits is equivalent to lt h3 gt lt a name Concerning Hobbits gt Concerning Hobbits lt a gt lt h3 gt Thus headings using this notation should not contain characters that may not be part of URL labels except for whitespace If you need to create such headings you have to use the explicit X HTML markup A hypertext link to a heading written2. hh end hh Odoc or in the following 97 ecc hh g x gt Ah fun gt end LY 23 1 1 12 Macro expansion Before the content of a tag is parsed the text undergoes macro expansion The syntax for macro calls is or name name argument EDoc Application 1 1 Welcome to EDoc where name and argument are separated by one or more whitespace characters The argument can be any text which may contain other macro calls The number of non escaped and delimiters must be balanced The argument text is first expanded in the current environment and the result is bound to the macro parameter written 7 If no argument is given e is bound to the empty string The macro definition is then substituted for the call and expansion continues over the resulting text Recursive macro expansions are not allowed User defined macros Users can define their own macros by using the def EDoc option see edoc file 2 page 23 and edoc get_doc 2 page 24 for more information User defined macros override predefined macros Predefined macros date Expands to the current date as Month Day Year eg Jun 7 2009 docRoot Expands to the relative URL path such as from the current page to the root directory of the generated documentation This can be used to create X HTML references such as lt img src docRoot images logo jpeg gt that are independent of how deep do
3. lt em gt Interesting Times lt em gt h Victor Gollancz Ltd 1994 EDoc Application 5 Chapter 1 EDoc User s Guide hh Oreference See lt a href www google com gt Google lt a gt for hh more information see See the see function tag page 6 for details since Specifies when the module was introduced with respect to the application package release or distribution it is part of The content can be arbitrary text version Specifies the module version The content can be arbitrary text 1 1 8 Function tags The following tags can be used before a function definition deprecated See the deprecated module tag page 5 for details doc XHTML text describing the function The first sentence of the text is used as a quick summary this ends at the first period character or exclamation mark that is followed by a whitespace character aline break or the end of the tag text and is not within X ML markup As an exception the first sentence may be within an initial paragraph element equiv Specify equivalence to another function call expression The content must be a proper Erlang expression If the expression is a function call a cross reference to the called function is created automatically Typically this tag is used instead of doc hidden Marks the function so that it will not appear in the documentation even if private documentation is generated Useful for debug test functions etc The conten
4. app_default and doc path See also edoc get_doc 3 page 24 edoc_extract source 4 page 31 get_first_sentence Es gt term is_name Cs gt term is_relative_uri Cs gt term is_space Cs gt term join_uri Base Path gt term lines Cs gt term parse_contact S L gt term ED oc contact information parsing This is the type of the content in eg author page 5 tags parse_expr S L gt term ED oc Erlang expression parsing For parsing things like the content of equiv page 6 tags and strings denoting file names e g in headerfile Also used by edoc_run page 37 read_info_file Dir gt term run_doclet Fun Opts gt term See edoc run 3 page 26 for a description of the doclet option run _layout Fun Opts gt term See edoc layout 2 page 24 for a description of the layout option segment Es N gt term simplify_path P gt term split_at Cs K gt term EDoc Application 35 edoc_lib EDoc Reference M anual split_at_space Cs gt term split_at_stop Cs gt term strip_space Cs gt term timestr X1 gt term to_label Cs gt term transpose Xss gt term try_subdir Dir Subdir gt term unique Xs gt term uri_get Path gt term write_file Text deep_string Dir filename see module edoc Name filename see module edoc gt ok Write the given Text to the file named by Name in directory D
5. bool Ifthe valueis true documentation of hidden functions will also be included The default value is false private bool Ifthe value is true documentation of private functions will also be included The default value is false todo bool If the value is true To Do notes written using todo or TODO tags will be included in the documentation The default value is false See read_source 2 page 25 read_comments 2 page 25 and edoc_lib get_doc_env 4 page 35 for further options See also get_doc 3 page 24 layout 2 page 24 read 2 page 25 run 3 page 26 edoc_extract source 5 page 32 get_doc File filename Env edoc_env see module edoc_lib Options proplist gt ModuleName edoc_module Types e ModuleN ame atom Like get_doc 2 page 24 but for a given environment parameter Env is an environment created by edoc_lib get_doc_env 4 page 35 layout Doc edocmodule gt string Equivalent to layout D oc page 24 layout Doc edoc module Options proplist gt string Transforms ED oc module documentation data to text The default layout creates an HTML document O ptions layout Module atom Specifies a callback module to be used for formatting The module must export a function module Doc Options The default callback module is edoc_layout page 33 see edoc_layout module 2 page 33 for layout specific options See also file 2 page 23 la
6. clear tag makes sure that ED oc does not see two doc tags before the function bar even if the code for function foo is removed by preprocessing There is no way for ED oc to see what the first doc tag really belongs to since preprocessing strips away all such information docfile Reads a plain documentation file on the same format as an overview file see The overview page page 3 for details and uses the tags in that file as if they had been written in place of the docfile tag The content is the name of the file to be read leading and trailing whitespace is ignored See also headerfile page 4 end The text following this tag is always ignored Use this to mark the end of the previous tag when necessary as e g in EDoc Application 3 Chapter 1 EDoc User s Guide N VS ERO hh Odoc VA ases hh end 0 rire ori ina a A to avoid including the last ruler line in the doc tag N ote using some other dummy tag for the same purpose might work in a particular implementation of ED oc but is not guaranteed to Always use end to ensure future compatibility Cheaderfile Similar to the docfile tag page 3 but reads a file containing Erlang source code generally this should be a header file with the extension hr1 If the file turns out to contain one or more function definitions or a module declaration all tags that occur above the last such definition or module declaration are ignored and EDo
7. hh http user it uu se richardc author lt richardc it uu se gt kh Cauthor richardc it uu se http user it uu se richardc copyright Specifies the module copyrights The content can be arbitrary text for example hh Ocopyright 2001 2003 Richard Carlsson deprecated Mark the module as deprecated indicating that it should no longer be used The content must be well formed XHTML and should preferably include a 1ink reference to a replacement as in hh deprecated Please use the module link foo instead doc Describes the module using well formed X HTML text The first sentence is used as a summary see the doc function tag page 6 for details For example hh Odoc This is a lt em gt very lt em gt useful module It is hidden Marks the module so that it will not appear in the documentation even if private documentation is generated Useful for sample code test modules etc The content can be used as acomment it is ignored by EDoc private Marks the module as private i e not part of the public interface so that it will not appear in the normal documentation If private documentation is generated the module will be included The content can be used as a comment it is ignored by EDoc reference Specifies a reference to some arbitrary external resource such as an article book or web site The content must be well formed X HTML text Examples hh Oreference Pratchett T
8. or failure to the operating system packages Args stringO gt none Calls edoc application 2 page 22 with the corresponding arguments The strings in the list are parsed as Erlang constant terms The list can be either Packages or Packages Options In the first case edoc application 1 page 22 is called instead The function call never returns instead the emulator is automatically terminated when the call has completed signalling success or failure to the operating system See also edoc page 22 38 EDoc Application List of Tables a o A ye ee Ste de e pe RF Bide ee vag ey EDoc Application List of Tables 40 EDoc Application Index of Modules and Functions M odules are typed in this way Functions are typed in this way application 1 edoc 22 edoc_run 37 copy_file 2 edoc_lib 34 count 2 edoc_lib 34 datestr 1 edoc_lib 34 edoc application 1 22 file 1 23 files 1 23 get_doc 1 23 24 layout 1 24 packages 1 24 read 1 25 read_comments 1 25 read_source 1 25 run 1 26 edoc_doclet run 1 28 edoc_extract file 1 30 header 1 30 header 2 30 31 source 1 31 source 2 31 32 text 1 32 edoc_layout module 2 33 overview 2 33 package 2 33 type 1 33 edoc_lib EDoc Application copy_file 2 34 count 2 34 datestr 1 34 escape_uri 1 34 filename 1 34 find_doc_dirs 0 34 find_file 3 34 find_sources 2 34 find_sources 3 34 get_doc_env 1 34 get_
9. source 5 page 32 but reads the syntax tree and the comments from the specified file See also source 4 page 31 edoc read_comments 2 page 25 edoc read_source 2 page 25 source Forms File filename Env edoc_env Options proplist gt ModuleName edoc_module Types e Forms syntaxTree syntaxTree e ModuleN ame atom e edoc_module see module edoc Extracts ED oc documentation from commented source code syntax trees The given Forms must be a single syntax tree of type form_list or a list of syntax trees representing program forms cf edoc read_source 2 page 25 Env is an environment created by edoc_lib get_doc_env 4 page 35 The File argument is used for error reporting and output file name generation only See edoc get_doc 2 page 24 for descriptions of the def hidden private and todo options See also erl_recomment 3 source 5 page 32 edoc read_comments 2 page 25 edoc read_source 2 page 251 EDoc Application 31 edoc_extract EDoc Reference Manual source Forms Comments comment File filename Env edoc_env Options proplist gt ModuleName edoc_module Types e Forms syntaxTree syntaxTree e Line Column Indentation Text e Line integer e Column integer e Indentation integer e Text string e ModuleN ame atom Like source 4 page 31 but first inserts the given comments in the syntax trees The
10. syntax trees must contain valid position information Cf edoc read_comments 2 page 251 See also erl_recomment 3 source 3 page 31 source 4 page 31 edoc read_comments 2 page 25 edoc read_source 2 page 251 text Text string Context Env edoc_env Options proplist gt Tags 32 Types e Context overview package e Tags term Returns the list of tags in the text Any lines of text before the first tag are ignored Env is an environment created by edoc_lib get_doc_env 4 page 35 See source 4 page 31 for a description of the def option See also edoc page 22 EDoc Application EDoc Reference Manual edoc_layout edoc_layout Erlang Module The standard HTML layout module for ED oc See the edoc page 22 module for details on usage Exports module Element Options gt term The layout function O ptions to the standard layout index_columns integer Specifies the number of column pairs used for the function index tables The default value is 1 stylesheet string Specifies the URI used for referencing the stylesheet The default value is stylesheet css If an empty string is specified no stylesheet reference will be generated sort_functions bool If true the detailed function descriptions are listed by name otherwise they are listed in the order of occurrence in the source file The default value is true xml_export Module atom Specifies an xmerl
11. EDoc Application version 0 7 Typeset in IATEX from SGML source using the D ocBuilder 0 9 8 5 Document System Contents 1 EDoc User s Guide 1 1 1 WelcometoEDOC LL iu e E a 1 LEE Contents 22 rr a AAA a a 1 1127 Intioduetionz pas aiar eta ara 2 EES RUNNINGIEDIOG e put ae iaia 2 1 1 4 The overview page aoaaa aaa 3 AR A Eire dd RL 3 1 16 OVERVIEW TAS 1 ii e A E i A Ee 4 LT Module tags ca our LE I ee oe AIR 5 11 95 FUNCION tags 264 0 ri A e RM gl A RI 6 1 19 Referentes y iui ana al ta 7 L L 10 Notes On XHTML ea ea ele See aa 7 LAL LE Wiki notation 6 25 oF e ae a od DA ad a A 8 1 1 12 Macro expansion o aoaaa aa 10 11513 TYPE Specifications virile A ae aa Be 12 1 1 14 Acknowledgements LL 14 2 EDoc Reference Manual 17 2 1 CHOC toh A AY AAA AA A RA 22 2 2 doc doclet 2B BA AAD do rs hte AAA totem eee 28 2 3 edoc extracts a te A ra Bo tp ee es a Beak oh Sead 30 2 4 edocalayQUE a ee e Se teh Ee ee 33 2 5 edoch ete g do deere a deere ARA ek AK late e q AA ks 34 2 6 COG TUN an RR oe else bee de ile dei 37 List of Tables 39 EDoc Application iii EDoc Application Chapter 1 EDoc User s Guide EDoc is the Erlang program documentation generator Inspired by the Javadoc TM tool for the Java TM programming language ED oc is adapted to the conventions of the Erlang world and has several features not found in Javadoc 1 1 Welcome to EDoc EDocisthe Erlang program documentation genera
12. Main doclet entry point edoc_extract The following functions are exported file File filename Context Env edoc_env Options proplist gt ok Tags error Reason page 30 Reads a text file and returns the list of tags in the file EDoc Application EDoc Reference Manual e header File filename Env edoc_env Options proplist gt ok Tags error Reason page 30 Similar to header 5 but reads the syntax tree and the comments from the specified file header Forms File filename Env edoc_env Options proplist gt ok Tags error Reason page 30 Extracts EDoc documentation from commented header file syntax trees header Forms Comments comment File filename Env edoc_env Options proplist gt ok Tags error Reason page 30 Similar to header 4 but first inserts the given comments in the syntax trees source File filename Env edoc_env Options proplist gt ModuleName edoc_module page 31 Like source 5 but reads the syntax tree and the comments from the specified file source Forms File filename Env edoc_env Options proplist gt ModuleName edoc_module page 31 Extracts EDoc documentation from commented source code syntax trees source Forms Comments comment File filename Env edoc_env Options proplist gt ModuleName edoc_module page 31 Like source 4 but first inserts the giv
13. Term The content is a type expression see Type specifications page 12 and can be a union type Note that exceptions of type exit as caused by calls to erlang exit Term and error run time errors such as badarg or badarith are not viewed as part of the normal interface of the function and cannot be documented with the throws tag type See the type generic tag page 4 for details Placing a type tag by a function definition may be convenient but does not affect where the description is placed in the generated documentation 6 EDoc Application 1 1 Welcome to EDoc 1 1 9 References In several contexts see tags 1ink macros etc ED oc lets you refer to the generated documentation for modules functions datatypes and applications using a simple and compact syntax The possible formats for references are edoc doc module page 2 ee dodat elocedoc module Table 1 1 reference syntax ED oc will resolve references using the information it finds in edoc info files at the locations specified with the doc_path option EDoc will automatically and somewhat intelligently try to find any local edoc info files using the current code path and add them to the end of the doc_path list The target doc directory is also searched for an existing info file this allows documentation to be built incrementally Use the new option to ignore any old info file Note that if the name of a module function or datatype is expl
14. Variables UnionType DefList For a truly abstract data type no equivalence is specified The main definition may be followed by additional local definitions Examples hh Ctype myList X A special kind of lists hh Otype filename string Atoms not allowed hh type thing A thong A hh A term h A kind of wrapper type thingy EDoc Application 13 Chapter 1 EDoc User s Guide Pre defined data types The following data types are predefined by ED oc and may not be redefined any atom binary bool char cons deep_string float function integer list nil none number pid port reference string term tuple D etails e any means any Erlang data type term is simply an alias for any O e atom binary float function integer pid port and reference are primitive data types of the Erlang programming language bool is the subset of atom consisting of the atoms true and false char O is a subset of integer O representing character codes tuple is the set of all tuples list T isjust an alias for T nil isan alias for the empty list cons H T is the list constructor This is usually not used directly It is possible to recursively define list T nil cons T list T string isan alias for char O e deep_string is recursively defined as char deep_string e none m
15. age 25 EDoc Application 27 edoc_doclet run Command EDoc Reference Manual edoc_doclet Erlang M odule Standard doclet module for ED oc DATA TYPES doclet_gen doclet_gen sources string app no_app atom packages atom mo doclet_toc doclet_gen paths string indir string edoc_context context dir string env edoc_env see module edoc_lib opts term no_app A value used to mark absence of an Erlang application context Use the macro NO_APP defined in edoc_doclet hrl to produce this value Exports doclet_gen doclet_toc Ctxt edoc_context gt ok Main doclet entry point See the file edoc_doclet hrl3 for the data structures used for passing parameters Also see edoc layout 2 page 24 for layout related options and edoc get_doc 2 page 24 for options related to reading source files O ptions file_suffix string Specifies the suffix used for output files The default value is html hidden bool If the value is true documentation of hidden modules and functions will also be included The default value is false overview edoc filename Specifies the name of the overview file By default this doclet looks for a file overview edoc in the target directory private bool Ifthe value is true documentation of private modules and functions will also be included The default value is false stylesheet string Specifies the URI used
16. also application 1 page 22 application Application atom Dir filename Options proplist gt ok Run EDoc on an application located in the specified directory Tries to automatically set up good defaults Unless the user specifies otherwise e The doc subdirectory will be used as the target directory if it exists otherwise the application directory is used e The source code is assumed to be located in the src subdirectory if it exists or otherwise in the application directory itself IURL priv edoc dtd 22 EDoc Application EDoc Reference Manual edoc e The subpackages page 26 option is turned on All found source files will be processed e The include subdirectory is automatically added to the include path Only important if preprocessing page 25 is turned on See run 3 page 26 for details including options See also application 2 page 22 file Name filename gt ok This function is deprecated See file 2 page 23 for details Equivalent to file N ame page 23 file Name filename Options proplist gt ok files Files files Files get_doc File get_doc File This function is deprecated This is part of the old interface to ED oc and is mainly kept for backwards compatibility The preferred way of generating documentation is through one of the functions application 2 page 22 packages 2 page 25 and files 2 page 23 Reads a source code file and outputs f
17. an element like the HTML lt br gt which has no actual content you can write either the full lt br gt lt br gt or better use the XHTML abbreviated form lt br gt Since the purpose of ED oc is to document programs there is also a limited form of wiki syntax available for making program code easier to write inline and to make the doc comments easier to read See Wiki notation page 8 for details The HTML heading tags h1 and h2 are reserved for use by ED oc H eadings in documentation source code should start at h3 There is however a special syntax for writing headings which avoids using specific level numbers altogether see H eadings page 9 for details ED oc uses X MerL to parse and export XML markup 1 1 11 Wiki notation When ED oc parses X HTML it does additional pre and post processing of the text in order to expand certain notation specific to EDoc into proper X HTML markup This wiki http en wikipedia org wiki W iki notation is intended to make it easier to write source code documentation Empty lines separate paragraphs Leaving an empty line in XHTML text i e a line which except for any leading start of comment characters contains only whitespace will make ED oc split the text before and after the empty line into separate paragraphs For example hh doc This will all be part of the first paragraph h It can stretch over several lines and contain lt em gt any XHTML markup lt em gt
18. c will print a warning This tag allows you to write documentation in a header file and insert it at a specific place in the documentation even if the header file is used i e included by several modules The includes option can be used to specify a search path see edoc read_source 2 page 25 todo or T0D0 Attaches a To Do note to a function module package or overview page The content can be any XHTML text describing the issue e g h TODO Finish writing the documentation or hh todo Implement lt a href http www ietf org rfc rfc2549 txt gt RFC 2549 lt a gt These tags can also be written as TODO e g TODO call your mother see Wiki notation page 8 for more information To D o notes are normally not shown unless the todo option is turned on see edoc get_doc 2 page 24 type Documents an abstract data type or type alias The content consists of a type declaration or definition optionally followed by a period separator and XHTML text describing the type i e its purpose use etc There must be at least one whitespace character between the and the text See Type specifications page 12 for syntax and examples All data type descriptions are placed in a separate section of the documentation regardless of where the tags occur 1 1 6 Overview tags The following tags can be used in an overview file Cauthor See the author module tag page 5 for details copyright See the c
19. callback module to be used for exporting the documentation See xmerl export_simple 3 for details See also edoc layout 2 page 24 overview E Options gt term package E Options gt term type E gt term See also edoc page 22 EDoc Application 33 edoc_lib EDoc Reference M anual edoc_lib Erlang Module Utility functions for ED oc DATA TYPES edoc_env Environment information needed by EDoc for generating references The data representation is not documented info info name string mail string uri string Exports copy_file From To gt term count X Xs gt term datestr X1 gt term escape_uri Cs gt term filename T gt term find_doc_dirs gt term find file Ps Pkg Name gt term find_sources Path Opts gt term find_sources Path Pkg Opts gt term See edoc run 3 page 26 for a description of the options subpackages source_suffix and exclude_packages get_doc_env Options proplist gt edoc_env Equivalent to get_doc_env O pts page 35 get doc_env App Packages Modules Options proplist gt edoc_env Y EDoc Application EDoc Reference Manual edoc_lib Types e App atom e Packages atom e Modules atom term Creates an environment data structure used by parts of ED oc for generating references etc See edoc run 3 page 26 for a description of the options file_suffix
20. dividual modules By default the overview page is generated from the file overview edoc in the target directory typically this is the doc subdirectory of the application directory see edoc_doclet page 28 for details The format of the overview file is the same as for ED oc documentation comments see Introduction page 2 except that the lines do not have leading characters Furthermore all lines before the first tag line are ignored and can be used as a comment All tags in the overview file such as doc version etc refer to the application as a whole see O verview tags page 4 for details H ere is an example of the contents of an overview file this is the overview doc file for the application frob author R J Hacker lt rjh acme com gt copyright 2007 R J Hacker version 1 0 0 title Welcome to the frob application doc frob is a highly advanced frobnicator with low latency 1 15 Generic tags The following tags can be used anywhere within a module clear This tag causes all tags above it up to the previous program construct to be discarded including the clear tag itself The text following the tag is also ignored This is typically only useful in code containing conditional compilation when preprocessing is turned on Preprocessing is turned off by default E g in ifdef DEBUG hh doc skoe h O gt a endif h Oclear hh doc bar gt the
21. doc 25 read_info_file 1 edoc_lib 35 read_source 1 edoc 25 run 1 edoc 26 edoc_doclet 28 run_doclet 2 edoc_lib 35 run_layout 2 edoc_lib 35 segment 2 edoc_lib 35 simplify_path 1 edoc_lib 35 source 1 edoc_extract 31 source 2 edoc_extract 31 32 EDoc Application split_at 2 edoc_lib 35 split_at_space 1 edoc lib 36 split_at_stop 1 edoc_lib 36 strip_space 1 edoc_lib 36 text 1 edoc_extract 32 timestr 1 edoc_lib 36 to_label 1 edoc_lib 36 transpose 1 edoc_lib 36 try_subdir 2 edoc_lib 36 type 1 edoc_layout 33 unique 1 edoc_lib 36 uri_get 1 edoc_lib 36 write_file 1 edoc_lib 36 write_info_file 4 edoc_lib 36 EDoc Application Index of Modules and Functions Index of Modules and Functions 44 EDoc Application
22. doc_env 4 34 get_first_sentence 1 35 is_name 1 35 is_relative_uri 1 35 is_space 1 35 join_uri 2 35 lines 1 35 parse_contact 2 35 parse_expr 2 35 read_info_file 1 35 run_doclet 2 35 run_layout 2 35 segment 2 35 simplify_path 1 35 split_at 2 35 split_at_space 1 36 split_at_stop 1 36 strip_space 1 36 timestr 1 36 to_label 1 36 transpose 1 36 try_subdir 2 36 unique 1 36 uri_get 1 36 write_file 1 36 write_info_file 4 36 edoc_run application 1 37 file 1 37 files 1 37 41 Index of Modules and Functions packages 1 38 escape_uri 1 edoc_lib 34 file 1 edoc 23 edoc_extract 30 edoc_run 37 filename 1 edoc_lib 34 files 1 edoc 23 edoc_run 37 find_doc_dirs 0 edoc_lib 34 find_file 3 edoc_lib 34 find_sources 2 edoc_lib 34 find_sources 3 edoc_lib 34 get_doc 1 edoc 23 24 get_doc_env 1 edoc_lib 34 get_doc_env 4 edoc_lib 34 get_first_sentence 1 edoc_lib 35 header 1 edoc_extract 30 header 2 edoc_extract 30 31 is_name 1 edoc_lib 35 is_relative_uri 1 edoc_lib 35 is_space 1 edoc_lib 35 join_uri 2 edoc_lib 35 layout 1 edoc 24 lines 1 edoc_lib 35 module 2 edoc_layout 33 overview 2 edoc_layout 33 package 2 edoc_layout 33 packages 1 edoc 24 edoc_run 38 parse_contact 2 edoc_lib 35 parse_expr 2 edoc_lib 35 read 1 edoc 25 read_comments 1 e
23. e directory structure reflects this The default value is true Usually this does the right thing even if all the modules belong to the top level empty package no_packages is an alias for packages false See the subpackages option below for further details If the source code is organized in a hierarchy of subdirectories although it does not use packages use no_packages together with the recursive search subpackages option on by default to automatically generate documentation for all the modules source_path filename Specifies a list of file system paths used to locate the source code for packages source_suffix string Specifies the expected suffix of input files The default value is erl EDoc Application EDoc Reference Manual edoc subpackages bool If the value is true all subpackages of specified packages will also be included in the documentation The default value is false no_subpackages isan alias for subpackages false See also the exclude_packages option Subpackage source files are found by recursively searching for source code files in subdirectories of the known source code root directories Also see the source_path option Directory names must begin with a lowercase letter and contain only alphanumeric characters and underscore or they will be ignored For example a subdirectory named test files will not be searched See also application 2 page 22 files 2 page 23 packages 2 p
24. e target directory corresponding to the specified package e write_info_file App Packages Modules Dir gt term page 36 edoc_run The following functions are exported e application Args string gt none page 37 Calls edoc application 3 with the corresponding arguments e file Args string gt none page 37 Calls edoc file 2 with the corresponding arguments e files Args string gt none page 37 Calls edoc files 2 with the corresponding arguments e packages Args string gt none page 38 Calls edoc application 2 with the corresponding arguments EDoc Application 21 edoc EDoc Reference Manual edoc Erlang M odule EDoc the Erlang program documentation generator This module providesthe main user interface to ED oc e EDoc User Manual page 1 e Running ED oc page 2 DATA TYPES edoc_module The EDoc documentation data for a module expressed as an XML document in X MerL format See the file edoc dtd for details filename filename see module kernel file package atom string proplist term syntaxTree syntaxTree see module syntax_tools erl_syntax Exports application Application atom gt ok Equivalent to application A pplication page 22 application Application atom Options proplist gt ok Run EDoc on an application in its default app directory See application 3 page 22 for details See
25. eans no data type E g a function that never returns has type gt none 1 1 14 Acknowledgements Since the first version of EDoc several people have come up with suggestions Luke Gorrie Joe Armstrong Erik Stenman Sean Hinde UIf Wiger and some have even submitted code to demonstrate their ideas Vlad Dumitrescu Johan Blom Vijay Hirani None of that code was actually included in the Great Rewriting that followed the initial public release ED oc version 0 1 but most of the central points were addressed in the new system such as better modularization and 14 EDoc Application 1 1 Welcome to EDoc possibility to plugin different layout engines and making ED oc understand the application directory layout It is now getting too hard to keep track of all the people who have made further suggestions or submitted bug reports but your input is always appreciated Thank you EDoc Application 15 Chapter 1 EDoc User s Guide 16 EDoc Application EDoc Reference Manual Short Summaries Erlang M odule edoc page 22 EDoc the Erlang program documentation generator Erlang M odule edoc_dodet page 28 Standard doclet module for ED oc Erlang M odule edoc_extract page 30 ED oc documentation extraction Erlang M odule edoc_layout page 33 The standard HTML layout module for EDoc Erlang M odule edoc_lib page 34 Utility functions for EDoc Erlang M odule edoc_run page 37 Interface
26. eing interpreted as delimiters for example to produce the text in the output or use a character in the argument text of a macro call the following escape sequences may be used ef Expands to Example h doc A macro call starts with the sequence EDoc Application 11 Chapter 1 EDoc User s Guide Expands to Example hh doc foo Key Value ee Expands to e Example hh doc Contact us at supportC0 Chostname Will generate the text Contact us at support vaporware acme com if the macro hostname is bound to vaporware acme com Also h doc You might want to write something like hh foo that will expand to foo and does not start a new tag even if it appears first in a line 1 1 13 Type specifications Function specifications The following grammar describes the form of the specifications following a spec tag A suffix implies that the element is optional Function types have higher precedence than union types e g atomO gt atom integer is parsed as atom gt atom integer not as atom gt atom integer Spec FunType where DefList FunctionName FunType where DefList FunctionName Atom FunType UnionTypes gt UnionType UnionTypes UnionType UnionType UnionTypes UnionType UnionList Name UnionList Name Variable UnionList Type Type Uni
27. en comments in the syntax trees e text Text string Context Env edoc_env Options proplist gt Tags page 32 Returns the list of tags in the text edoc_layout The following functions are exported e module Element Options gt term page 33 The layout function e overview E Options gt term page 33 e package E Options gt term page 33 e type E gt term page 33 edoc_lib The following functions are exported e copy file From To gt term page 34 e count X Xs gt term page 34 EDoc Application 19 EDoc Reference Manual datestr X1 gt term page 34 escape_uri Cs gt term page 34 filename T gt term page 34 find_doc_dirs gt term page 34 find_file Ps Pkg Name gt term page 34 find_sources Path Opts gt term page 34 find_sources Path Pkg Opts gt term page 34 See edoc run 3 for a description of the options subpackages source_suffix and exclude_packages get_doc_env Options proplist gt edoc_env page 34 Equivalent to get_doc_env O pts get_doc_env App Packages Modules Options proplist gt edoc_env page 34 Creates an environment data structure used by parts of ED oc for generating references etc get_first_sentence Es gt term page 35 is_name Cs gt term page 35 is_relative_uri Cs gt term page 35 is_space Cs g
28. for options related to reading source files Options app default string Specifies the default base URI for unknown applications application App atom Specifies that the generated documentation describes the application App This mainly affects generated references dir filename Specifies the target directory for the generated documentation doc_path string Specifies a list of URI s pointing to directories that contain EDoc generated documentation URI without a scheme part are taken as relative to file Note that such paths must use as separator regardless of the host operating system doclet Module atom Specifies a callback module to be used for creating the documentation The module must export a function run Cmd Ctxt The default doclet module is edoc_doclet page 28 see edoc_doclet run 2 page 28 for doclet specific options exclude_packages package Lists packages to be excluded from the documentation Typically used in conjunction with the subpackages option file_suffix string Specifies the suffix used for output files The default value is html Note that this also affects generated references new bool If the value is true any existing edoc info file in the target directory will be ignored and overwritten The default value is false packages bool If the value is true it it assumed that packages module namespaces are being used and that the source cod
29. for calling ED oc from Erlang startup options edoc The following functions are exported application Application atom gt ok page 22 Equivalent to application A pplication application Application atom Options proplist gt ok page 22 Run EDoc on an application in its default app directory application Application atom Dir filename Options proplist gt ok page 22 Run EDoc on an application located in the specified directory file Name filename gt ok page 23 Equivalent to file N ame file Name filename Options proplist gt ok page 23 Reads a source code file and outputs formatted documentation to a corresponding file files Files filename package filename gt ok page 23 Equivalent to packages Packages files Files filename package filename Options proplist gt ok page 23 Runs ED oc on a given set of source files get_doc File filename gt ModuleName edoc_module page 23 Equivalent to get_doc File EDoc Application 17 EDoc Reference Manual get_doc File filename Options proplist gt ModuleName edoc_module page 23 Reads a source code file and extracts ED oc documentation data get_doc File filename Env edoc_env see module edoc_lib Options proplist gt ModuleName edoc_module page 23 Like get_doc 2 but for a given environment parameter layo
30. for referencing the stylesheet The default value is stylesheet css If an empty string is specified no stylesheet reference will be generated 2URL include edoc_doclet hrl 3URL include edoc_doclet hrl EDoc Application EDoc Reference Manual edoc_doclet stylesheet file edoc filename Specifies the name of the stylesheet file By default this doclet uses the file stylesheet css in the priv subdirectory of the EDoc installation directory The named file will be copied to the target directory title string Specifies the title of the overview page See also edoc page 22 EDoc Application 29 edoc_extract EDoc Reference Manual edoc_extract Erlang M odule EDoc documentation extraction DATA TYPES edoc_env edoc_env see module edoc_lib filename filename see module file Exports file File filename Context Env edoc_env Options proplist gt ok Tags header File header Forms error Reason Types e Context overview package e Tags term e Reason term Reads a text file and returns the list of tags in the file A ny lines of text before the first tag are ignored Env is an environment created by edoc_lib get_doc_env 4 page 35 Upon error Reason is an atom returned from the call to file read_file 1 See text 4 page 32 for options filename Env edoc_env Options proplist gt ok Tags error Reason Ty
31. icitly qualified with an application as in edoc edoc_run this overrides any other information about that name and the reference will be made relative to the location of the application if it can be found This makes it possible to refer to eg amodule fred as foo fred without accidentally getting a reference to bar fred You should not use this form of explicit references for names that are local to the application you are currently creating they will always be resolved correctly N ote that module local references such as file 2 only work properly within a module In an overview page like this i e the one you are currently reading no module context is available 1 1 10 Notes on XHTML In several places X HTML markup can be used in the documentation text in particular in doc tags The main differences from HTML are the following e All elements must have explicit start and end tags and be correctly nested This means that you cannot eg write a lt li gt tag without also writing a corresponding lt li gt tag in the right place This could be an annoyance at times but has the great advantage that ED oc can report all malformed X HTML in your source code rather than propagate the errors to the generated documentation e XHTML tag and attribute names should always be lower case e Attributes must be quoted asin e g lt a name top gt EDoc Application 7 Chapter 1 EDoc User s Guide To write
32. in doc Prints the value X record foo x y z print X gt the doc tag is associated with the function print 1 N ote that in a comment such as doc the tag is ignored because only the first character is considered leading This allows tags to be commented out Some tags such as type do not need to be associated with any program construct These may be placed at the end of the file in the footer 1 1 3 Running EDoc The following are the main functions for running ED oc e edoc application 2 page 22 Creates documentation for a typical Erlang application e edoc packages 2 page 25 Creates documentation for one or more packages automatically locating source files edoc files 2 page 23 Creates documentation for a specified set of source files edoc run 3 page 26 General interface function the common back end for the above functions O ptions are documented here N ote that the function edoc file 2 page 23 belongs to the old deprecated interface from ED oc version 0 1 and should not be used 2 EDoc Application 1 1 Welcome to EDoc 1 1 4 The overview page W hen documentation is generated for an entire application an overview page or front page is generated The page you are now reading is an overview page This should contain the high level description or user manual for the application leaving the finer details to the documentation for in
33. ir If the target directory does not exist it will be created write_file Text deep_string Dir filename see module edoc Name filename see module edoc Package atom string gt ok Like write_file 3 page 36 but adds path components to the target directory corresponding to the specified package write_info_file App Packages Modules Dir gt term See also edoc page 22 36 EDoc Application EDoc Reference Manual edoc_run edoc_run Erlang Module Interface for calling EDoc from Erlang startup options The following is an example of typical usage in a M akefile docs erl noshell run edoc_run application APP_NAME An note the single quotes to avoid shell expansion and the double quotes enclosing the strings N ew feature in version 0 6 9 It is no longer necessary to write s init stop last on the command line in order to make the execution terminate The termination signalling success or failure to the operating system is now built into these functions Exports application Args string gt none O Calls edoc application 3 page 22 with the corresponding arguments The strings in the list are parsed as Erlang constant terms The list can be either App App Options or App Dir Options In the first case edoc application 1 page 22 is called instead in the second case edoc application 2 page 22 is called The function call never returns instead the em
34. onList Type UnionList Type TypeVariable Atom Integer Float FunType UnionTypes UnionType 1 UnionType TypeName UnionTypes ModuleName TypeName UnionTypes AppName ModuleName TypeName UnionTypes TypeVariable Variable TypeName Atom ModuleName Atom ModuleName Atom AppName Atom DefList Def DefList Def DefList Def Def TypeVariable UnionType TypeName TypeVariables UnionType TypeVariables TypeVariable TypeVariable TypeVariables Examples hh Cspec my_function X integer gt integer hh spec X integer gt integer hh spec sqrt float gt float hh spec pair S T gt S T 12 EDoc Application 1 1 Welcome to EDoc hh spec append List List gt List hh List term hh Ospec append A List B List gt List hh List Item hh Item term hh spec open File filename gt FileDescriptor hh where hh filename string atom hh FileDescriptor term hh spec close graphics window gt ok In the above examples X A B and File are parameter names used for referring to the parameters from the documentation text The type variables S T and List are used to simplify the type specifications and may be supplied with definitions It is also possible to give definitions for named types which means that the name i
35. opyright module tag page 5 for details doc See the doc module tag page 5 for details reference See the reference module tag page 5 for details see See the see module tag page 6 for details since See the since module tag page 6 for details title Specifies a title for the overview page This tag can only be used in an overview file The content can be arbitrary text 4 EDoc Application 1 1 Welcome to EDoc version See the version module tag page 6 for details 1 1 7 Module tags The following tags can be used before a module declaration author Specifies the name of an author along with contact information An e mail address can be given within lt gt delimiters and a URI within delimiters Both e mail and URI are optional and any surrounding whitespace is stripped from all strings The name is the first nonempty string that is not within lt gt or and does not contain only whitespace In other words the name can come before between or after the e mail and URI but cannot be split up any sections after the first are ignored If an e mail address is given but no name the e mail string will be used also for the name If no lt gt section is present but the name string contains an character it is assumed to be an e mail address Not both name and e mail may be left out Examples h Gauthor Richard Carlsson h Gauthor Richard Carlsson lt richardc it uu se gt
36. ormatted documentation to a corresponding file O ptions dir filename Specifies the output directory for the created file By default the output is written to the directory of the source file source_suffix string Specifies the expected suffix of the input file The default value is erl file_suffix string Specifies the suffix for the created file The default value is html See get_doc 2 page 24 and layout 2 page 24 for further options For running ED oc from a M akefile or similar see edoc_run file 1 page 37 See also read 2 page 25 filename O package filename gt ok Equivalent to packages Packages page 25 filename package filename Options proplist Q gt ok Runs ED oc on a given set of source files See run 3 page 26 for details including options filename gt ModuleName edoc_module Equivalent to get_doc File page 24 filename Options proplist gt ModuleName edoc_module Types e ModuleN ame atom EDoc Application 23 edoc EDoc Reference Manual Reads a source code file and extracts EDoc documentation data N ote that without an environment parameter see get_doc 3 page 24 hypertext links may not be correct Options def Macros e Macros Macro Macro e Macro Name atom Text string Specifies a set of ED oc macro definitions See Inline macro expansion page 10 for details hidden
37. pes e Tags term e Reason term Similar to header 5 page 31 but reads the syntax tree and the comments from the specified file See also header 4 page 31 edoc read_comments 2 page 25 edoc read_source 2 page 25 File filename Env edoc_env Options proplist gt ok Tags error Reason Types e Forms syntaxTree syntaxTree EDoc Application EDoc Reference Manual edoc_extract e Tags term e Reason term Extracts ED oc documentation from commented header file syntax trees Similar to source 5 page 32 but ignores any documentation that occurs before a module declaration or a function definition Warning messages are printed if content may be ignored Env is assumed to already be set up with a suitable module context See also erl_recomment 3 header 5 page 31 header Forms Comments comment File filename Env edoc_env Options proplist gt ok Tags error Reason Types e Forms syntaxTree syntaxTree e Tags term e Reason term Similar to header 4 page 31 but first inserts the given comments in the syntax trees The syntax trees must contain valid position information Cf edoc read_comments 2 page 25 See also erl_recomment 3 header 3 page 30 header 4 page 31 source File filename Env edoc_env Options proplist Q gt ModuleName edoc_module Types e ModuleN ame atom term Like
38. r completeness also gt in the quoted text have been escaped to 1t Lamp and gt respectively All whitespace is stripped from the beginning and end of the quoted text Double back quotes gt gt can be used to quote text containing single gt characters The automatic stripping of any surrounding whitespace makes it possible to write things like foo bar gt gt To quote text containing gt gt verbatim explicit lt code gt markup or similar must be used A character sequence gt gt gt will be expanded to lt pre gt lt CDATA 1 gt lt pre gt which disables all XML markup within the quoted text and displays the result in fixed font with preserved indentation W hitespace is stripped from the end of the quoted text but not from the beginning except for whole leading lines of whitespace This is useful for multi line code examples or displayed one liners To produce a single character in XML without beginning a new quote you can write gt no space between the and the gt You can of course also use the X ML character entity amp x60 Examples hh doc where the variable Foo refers to hh Odoc returns the atom foo erlang org hh doc use the command erl name foo to hh Odoc as in the following code hh X gt hh case X of hh ee
39. returns the list of source code form syntax trees O ptions preprocess bool If the value is true the source file will be read via the Erlang preprocessor epp The default value is false no_preprocess is an alias for preprocess false Normally preprocessing is not necessary for ED oc to work but if a file contains too exotic definitions or uses of macros it will not be possible to read it without preprocessing N ote comments in included files will not be availableto ED oc even with this option enabled includes Path string Specifies alist of directory names to be searched for include files if the preprocess option is turned on Also used with the Cheaderfile tag The default value is the empty list The directory of the source file is always automatically appended to the search path EDoc Application 25 edoc run Packages EDoc Reference Manual macros atom term Specifies a list of pre defined Erlang preprocessor epp macro definitions used if the preprocess option is turned on The default value is the empty list See also erl_syntax 3 get_doc 2 page 24 package Files filename package filename Options proplist gt ok Runs EDoc on a given set of source files and or packages N ote that the doclet plugin module has its own particular options see the doclet option below Also see layout 2 page 24 for layout related options and get_doc 2 page 24
40. s simply an alias Use the type tag to document abstract data types If a named type is defined in another module it can be referred to as Module TypeName Note that the keyword where is optional before a list of definitions and that the definitions in the list may optionally be separated by Both the and the character may be used to separate alternatives in union types there is no semantic difference N ote that the notation Type means proper nil terminated list whose elements all belong to Type For example atom integer means the same thing as atom integer i e a proper list of atoms and or integers If only a type variable is given for a parameter asin pair S T gt the same variable name may implicitly be used as the parameter name there is no need to write pair S S T T gt ED oc automatically extracts possible parameter names from the source code to be used if no parameter name is given in the specification or if the specification is missing altogether If this fails ED oc will generate a dummy parameter name such as X1 This way EDoc can often produce helpful documentation even for code that does not contain any annotations at all Type definitions The following grammar see above for auxiliary definitions describes the form of the definitions that may follow a type tag Typedef TypeName TypeVariables DefList TypeName Type
41. t term page 35 join_uri Base Path gt term page 35 lines Cs gt term page 35 parse_contact S L gt term page 35 EDoc contact information parsing parse_expr S L gt term page 35 EDoc Erlang expression parsing read_info_file Dir gt term page 35 run_doclet Fun Opts gt term page 35 See edoc run 3 for a description of the doclet option run_layout Fun Opts gt term page 35 See edoc layout 2 for a description of the layout option segment Es N gt term page 35 simplify_path P gt term page 35 EDoc Application EDoc Reference Manual e split_at Cs K gt term page 35 e split_at_space Cs gt term page 36 e split_at_stop Cs gt term page 36 e strip_space Cs gt term page 36 timestr X1 gt term page 36 e to_label Cs gt term page 36 e transpose Xss gt term page 36 try_subdir Dir Subdir gt term page 36 unique Xs gt term page 36 uri_get Path gt term page 36 write_file Text deep_string Dir filename see module edoc Name filename see module edoc gt ok page 36 Write the given Text to the file named by Name in directory Dir write_file Text deep_string Dir filename see module edoc Name filename see module edoc Package atom string gt ok page 36 Like write file 3 but adds path components to th
42. t can be used as a comment it is ignored by ED oc private Marks the function as private i e not part of the public interface so that it will not appear in the normal documentation If private documentation is generated the function will be included Only useful for exported functions eg entry points for spawn N on exported functions are always private The content can be used as a comment it is ignored by ED oc see Make a reference to a module function datatype or application See References page 7 The content consists of a reference optionally followed by a period one or more whitespace characters and X HTML text to be used for the label for example see edoc or see edoc lt b gt EDoc lt b gt If no label text is specified the reference itself is used as the label since Specifies in what version of the module the function was introduced cf the version module tag page 6 The content can be arbitrary text spec Used to specify the function type see Type specifications page 12 for syntax details If the function name is included in the specification it must match the name in the actual code When parameter names are not given in the specification suitable names will be taken from the source code if possible and otherwise synthesized throws Specifies which types of terms may be thrown by the function if its execution terminates abruptly due to a call to erlang throw
43. this way can be created using the section macro which transforms the argument text into a label as described above E g section Concerning Hobbits is eqivalent to writing lt a href Concerning Hobbits gt Concerning Hobbits lt a gt The above expansions take place before X ML parsing External links WritingaURL within brackets asin http www w3c org will generate a hyperlink such as http www w3c org 2 using the URL both for the destination and the label of the reference equivalent to writing lt a href http www w3c org gt lt tt gt http www w3c org lt tt gt lt a gt This short hand keeps external URL references short and readable The recognized protocols are http ftp and file This expansion takes place before X ML parsing TODO notes Lines that begin with the text TODO the colon is required are recognized as tags as if they had been written as Gtodo see todo tags page 4 for further details 2URL http www w3c org EDoc Application 9 Chapter 1 EDoc User s Guide Verbatim quoting In XHTML text the character Unicode 000060 known as grave accent or back quote can be used for verbatim quoting This expansion takes place before XML parsing A character sequence gt or gt gt will be expanded to lt code gt lt code gt where all occurrences of the special X ML characters lt and amp and fo
44. tor Inspired by the Javadoc TM tool for the Java TM programming language ED oc is adapted to the conventions of the Erlang world and has several features not found in Javadoc 1 1 1 Contents e Introduction page 2 Running ED oc page 2 The overview page page 3 Generic tags page 3 O verview tags page 4 M odule tags page 5 Function tags page 6 References page 7 Notes on XHTML page 7 Wiki notation page 8 M acro expansion page 10 Type specifications page 12 Acknowledgements page 14 EDoc Application Chapter 1 EDoc User s Guide 1 1 2 Introduction EDoc lets you write the documentation of an Erlang program as comments in the source code itself using tags on the form Name A source file does not have to contain tags for ED oc to generate its documentation but without tags the result will only contain the basic available information that can be extracted from the module A tag must be the first thing on a comment line except for leading characters and whitespace The comment must be between program declarations and not on the same line as any program text All the following text including consecutive comment lines up until the end of the comment or the next tagged line is taken as the content of the tag Tags are associated with the nearest following program construct of significance the module name declaration and function definitions O ther constructs are ignored e g
45. ulator is automatically terminated when the call has completed signalling success or failure to the operating system file Args string gt none This function is deprecated This is part of the old interface to ED oc and is mainly kept for backwards compatibility The preferred way of generating documentation is through one of the functions application 1 page 37 packages 1 page 38 and files 1 page 38 Calls edoc file 2 page 23 with the corresponding arguments The strings in the list are parsed as Erlang constant terms The list can be either File or File Options In the first case an empty list of options is passed to edoc file 2 page 23 The following is an example of typical usage in a M akefile DOCDIR html erl erl noshell run edoc_run file lt dir DOCDIR An The function call never returns instead the emulator is automatically terminated when the call has completed signalling success or failure to the operating system files Args string gt none EDoc Application 37 edoc_run EDoc Reference M anual Calls edoc files 2 page 23 with the corresponding arguments The strings in the list are parsed as Erlang constant terms The list can be either Files or Files Options In the first case edoc files 1 page 23 is called instead The function call never returns instead the emulator is automatically terminated when the call has completed signalling success
46. ut Doc edoc_module gt string page 24 Equivalent to layout D oc layout Doc edoc_module Options proplist gt string page 24 Transforms ED oc module documentation data to text packages Packages package gt ok page 24 Equivalent to packages Packages packages Packages package Options proplist gt ok page 24 Runs ED oc on a set of packages read File filename gt string page 25 Equivalent to read File read File filename Options proplist gt string page 25 Reads and processes a source file and returns the resulting ED oc text as a string read_comments File gt comment page 25 Equivalent to read_comments File read_comments File filename Options proplist gt comment O page 25 Extracts comments from an Erlang source code file read_source Name File gt syntaxTree page 25 Equivalent to read_source File read_source File filename Options proplist gt syntaxTree page 25 Reads an Erlang source file and returns the list of source code form syntax trees run Packages package Files filename package filename Options proplist gt ok page 26 RunsEDoc on a given set of source files and or packages edoc_doclet The following functions are exported run Command doclet_gen doclet_toc Ctxt edoc_context gt ok page 28
47. wn in a package structure they occur If packages are not used i e if all modules are in the empty package docRoot will always resolve to the empty string link reference description This creates a hypertext link cf the see function tag page 6 above for details The description text including the period separator is optional if no text is given the reference itself is used For example Glink edoc file 2 creates the link edoc file 2 page 23 and link edoc file 2 lt em gt this link lt em gt creates this link page 23 module Expands to the name of the current module Only defined when a module is being processed package Expands to the name of the current package section heading Expands to a hypertext link to the specified section heading see H eadings page 9 for more information time Expands to the current time as Hr Min Sec e g 19 15 42 type type expression Formats a type expression within lt code gt lt code gt markup and with hypertext links for data types For example type options List edoc optionlist 0 generates options List edoc optionlist Cf Escape sequences page 11 version Intended for use in version tags page 6 Defaults to a timestamp using date and time Typically this macro is redefined by the user when an official release of the application is generated Escape sequences To prevent certain characters from b
48. yout 1 page 24 read 2 page 25 run 3 page 26 packages Packages package gt ok Equivalent to packages Packages page 25 packages Packages package Options proplist gt ok 24 EDoc Application EDoc Reference Manual edoc Runs EDoc on a set of packages The source_path option is used to locate the files see run 3 page 26 for details including options This function automatically appends the current directory to the source path read File filename gt string Equivalent to read File page 25 read File filename Options proplist gt string Reads and processes a source file and returns the resulting ED oc text as a string See get_doc 2 page 24 and layout 2 page 24 for options See also file 2 page 23 read_comments File gt comment Equivalent to read_comments File page 25 read_comments File filename Options proplist gt comment Types e Line Column Indentation Text e Line integer e Column integer e Indentation integer e Text string Extracts comments from an Erlang source code file See the module erl_comment_scan 3 for details on the representation of comments Currently no options are avaliable read_source Name File gt syntaxTree Equivalent to read_source File page 25 read_source File filename Options proplist gt syntaxTree Reads an Erlang source file and
Download Pdf Manuals
Related Search