Navigation

Operators and Keywords

Function List:

C++ API

gen_doc_cache.m File Reference


Functions

function gen_doc_cache (out_file="doc-cache", directory=[]) if(!ischar(out_file)) print_usage()
endif if (isempty(directory)) cache
 elseif (ischar(directory)) cache
else error ("gen_doc_cache: second input argument must be a string")
endif if (!isempty(cache)) save("-text"
 if (length(f) > 2 &&all(f(1:2)=="_")) status
endif switch (lower(format)) case"plain text"status=0 = get_help_text ("Contents")

Variables

endif out_file
endif cache
endif endfunction function [text, first_sentence, status]
 return
case texinfo [text, status] = __makeinfo__ (text, "plain text")
case html [text, status] = strip_html_tags (text)
otherwise status = 1

Function Documentation

elseif ( ischar(directory  ) 

else error ( "gen_doc_cache: second input argument must be a string  ) 

function gen_doc_cache ( out_file  = "doc-cache",
directory  = [] 
)

if ( length(f)  ,
2 &&  allf(1:2)=="_" 
)

endif if ( isemptycache  ) 

endif if ( isempty(directory  ) 

switch ( lower(format  )  = get_help_text ("Contents") [pure virtual]


Variable Documentation

Initial value:

 handle_function (f, text, format)
  first_sentence = ""

case html = strip_html_tags (text)

return

otherwise status = 1

case texinfo = __makeinfo__ (text, "plain text")