aboutsummaryrefslogtreecommitdiffstats
path: root/lib/edoc/include
diff options
context:
space:
mode:
Diffstat (limited to 'lib/edoc/include')
-rw-r--r--lib/edoc/include/Makefile58
-rw-r--r--lib/edoc/include/edoc_doclet.hrl63
2 files changed, 121 insertions, 0 deletions
diff --git a/lib/edoc/include/Makefile b/lib/edoc/include/Makefile
new file mode 100644
index 0000000000..0533c27567
--- /dev/null
+++ b/lib/edoc/include/Makefile
@@ -0,0 +1,58 @@
+# ``The contents of this file are subject to the Erlang Public License,
+# Version 1.1, (the "License"); you may not use this file except in
+# compliance with the License. You should have received a copy of the
+# Erlang Public License along with this software. If not, it can be
+# retrieved via the world wide web at http://www.erlang.org/.
+#
+# Software distributed under the License is distributed on an "AS IS"
+# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+# the License for the specific language governing rights and limitations
+# under the License.
+#
+# The Initial Developer of the Original Code is Ericsson Utvecklings AB.
+# Portions created by Ericsson are Copyright 1999, Ericsson Utvecklings
+# AB. All Rights Reserved.''
+#
+# $Id$
+#
+include $(ERL_TOP)/make/target.mk
+include $(ERL_TOP)/make/$(TARGET)/otp.mk
+
+# ----------------------------------------------------
+# Application version
+# ----------------------------------------------------
+include ../vsn.mk
+VSN=$(EDOC_VSN)
+
+# ----------------------------------------------------
+# Release Macros
+# ----------------------------------------------------
+RELSYSDIR = $(RELEASE_PATH)/lib/edoc-$(VSN)
+
+# ----------------------------------------------------
+# Macros
+# ----------------------------------------------------
+
+INCLUDE_FILES = edoc_doclet.hrl
+
+# ----------------------------------------------------
+# Make Rules
+# ----------------------------------------------------
+debug opt:
+
+clean:
+
+docs:
+
+
+# ----------------------------------------------------
+# Release Targets
+# ----------------------------------------------------
+include $(ERL_TOP)/make/otp_release_targets.mk
+
+release_spec:
+ $(INSTALL_DIR) $(RELSYSDIR)/include
+ $(INSTALL_DATA) $(INCLUDE_FILES) $(RELSYSDIR)/include
+
+release_docs_spec:
+
diff --git a/lib/edoc/include/edoc_doclet.hrl b/lib/edoc/include/edoc_doclet.hrl
new file mode 100644
index 0000000000..a99ff1fbab
--- /dev/null
+++ b/lib/edoc/include/edoc_doclet.hrl
@@ -0,0 +1,63 @@
+%% =====================================================================
+%% Header file for EDoc doclet modules.
+%%
+%% Copyright (C) 2001-2004 Richard Carlsson
+%%
+%% This library is free software; you can redistribute it and/or modify
+%% it under the terms of the GNU Lesser General Public License as
+%% published by the Free Software Foundation; either version 2 of the
+%% License, or (at your option) any later version.
+%%
+%% This library is distributed in the hope that it will be useful, but
+%% WITHOUT ANY WARRANTY; without even the implied warranty of
+%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+%% Lesser General Public License for more details.
+%%
+%% You should have received a copy of the GNU Lesser General Public
+%% License along with this library; if not, write to the Free Software
+%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+%% USA
+%%
+%% Author contact: [email protected]
+%% =====================================================================
+
+-define(NO_APP, []).
+
+%% Context for doclets
+
+%% @type edoc_context() = #context{dir = string(),
+%% env = edoc_lib:edoc_env(),
+%% opts = [term()]}
+
+-record(context, {dir = "",
+ env,
+ opts = []}).
+
+%% Doclet commands
+
+%% @type no_app().
+%% A value used to mark absence of an Erlang application
+%% context. Use the macro `NO_APP' defined in
+%% <a href="../include/edoc_doclet.hrl">`edoc_doclet.hrl'</a>
+%% to produce this value.
+
+%% @type doclet_gen() = #doclet_gen{sources = [string()],
+%% app = no_app() | atom(),
+%% packages = [atom()],
+%% modules = [atom()],
+%% modules = [atom()],
+%% filemap = function()}
+
+-record(doclet_gen, {sources = [],
+ app = ?NO_APP,
+ packages = [],
+ modules = [],
+ filemap
+ }).
+
+%% @type doclet_toc() = #doclet_gen{paths = [string()],
+%% indir = string()}
+
+-record(doclet_toc, {paths,
+ indir
+ }).