← Back to branch summary

~ubuntu-branches/debian/squeeze/erlang/squeeze

« back to all changes in this revision

Viewing changes to lib/edoc/include/edoc_doclet.hrl

  • Committer: Bazaar Package Importer
  • Author(s): Erlang Packagers, Sergei Golovan
  • Date: 2006-12-03 17:07:44 UTC
  • mfrom: (2.1.11 feisty)
  • Revision ID: james.westby@ubuntu.com-20061203170744-rghjwupacqlzs6kv
Tags: 1:11.b.2-4
[ Sergei Golovan ]
Fixed erlang-base and erlang-base-hipe prerm scripts.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/edoc/include/edoc_doclet.hrl
 
1
%% =====================================================================
 
2
%% Header file for EDoc doclet modules.
 
3
%% 
 
4
%% Copyright (C) 2001-2004 Richard Carlsson
 
5
%%
 
6
%% This library is free software; you can redistribute it and/or modify
 
7
%% it under the terms of the GNU Lesser General Public License as
 
8
%% published by the Free Software Foundation; either version 2 of the
 
9
%% License, or (at your option) any later version.
 
10
%%
 
11
%% This library is distributed in the hope that it will be useful, but
 
12
%% WITHOUT ANY WARRANTY; without even the implied warranty of
 
13
%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 
14
%% Lesser General Public License for more details.
 
15
%%
 
16
%% You should have received a copy of the GNU Lesser General Public
 
17
%% License along with this library; if not, write to the Free Software
 
18
%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 
19
%% USA
 
20
%%
 
21
%% Author contact: richardc@csd.uu.se
 
22
%% =====================================================================
 
23
 
 
24
-define(NO_APP, []).
 
25
 
 
26
%% Context for doclets
 
27
 
 
28
%% @type edoc_context() = #context{dir = string(),
 
29
%%                                 env = edoc_lib:edoc_env(),
 
30
%%                                 opts = [term()]}
 
31
 
 
32
-record(context, {dir = "",
 
33
                  env,
 
34
                  opts = []}).
 
35
 
 
36
%% Doclet commands
 
37
 
 
38
%% @type no_app().
 
39
%%    A value used to mark absence of an Erlang application
 
40
%%    context. Use the macro `NO_APP' defined in
 
41
%%    <a href="../include/edoc_doclet.hrl">`edoc_doclet.hrl'</a>
 
42
%%    to produce this value.
 
43
 
 
44
%% @type doclet_gen() = #doclet_gen{sources = [string()],
 
45
%%                                  app = no_app() | atom(),
 
46
%%                                  packages = [atom()],
 
47
%%                                  modules = [atom()],
 
48
%%                                  modules = [atom()],
 
49
%%                                  filemap = function()}
 
50
 
 
51
-record(doclet_gen, {sources = [],
 
52
                     app = ?NO_APP,
 
53
                     packages = [],
 
54
                     modules = [],
 
55
                     filemap
 
56
                    }).
 
57
 
 
58
%% @type doclet_toc() = #doclet_gen{paths = [string()],
 
59
%%                                  indir = string()}
 
60
 
 
61
-record(doclet_toc, {paths,
 
62
                     indir
 
63
                    }).