% -*- texinfo -*-
% @deftypefn {Function File} html_help_text (@var{name}, @var{outname}, @var{options})
% Writes a function help text to disk formatted as @t{HTML}.
%
% The help text of the function @var{name} is written to the file @var{outname}
% formatted as @t{HTML}. The design of the generated @t{HTML} page is controlled
% through the @var{options} variable. This is a structure with the following
% optional fields.
%
% @table @samp
% @item header
% This field contains the @t{HTML} header of the generated file. Through this
% things such as @t{CSS} style sheets can be set.
% @item footer
% This field contains the @t{HTML} footer of the generated file. This should
% match the @samp{header} field to ensure all opened tags get closed.
% @item title
% This field sets the title of the @t{HTML} page. This is enforced even if the
% @samp{header} field contains a title.
% @end table
%
% @var{options} structures for various projects can be with the @code{get_html_options}
% function. As a convenience, if @var{options} is a string, a structure will
% be generated by calling @code{get_html_options}.
%
% @seealso{get_html_options, generate_package_html}
% @end deftypefn