From 84adefa331c4159d432d22840663c38f155cd4c1 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Fri, 20 Nov 2009 14:54:40 +0000 Subject: The R13B03 release. --- lib/edoc/doc/src/Makefile | 139 +++++++++++++++++++++++++ lib/edoc/doc/src/book.xml | 48 +++++++++ lib/edoc/doc/src/fascicules.xml | 15 +++ lib/edoc/doc/src/make.dep | 21 ++++ lib/edoc/doc/src/notes.xml | 221 ++++++++++++++++++++++++++++++++++++++++ lib/edoc/doc/src/part.xml | 38 +++++++ lib/edoc/doc/src/part_notes.xml | 38 +++++++ lib/edoc/doc/src/ref_man.xml | 43 ++++++++ 8 files changed, 563 insertions(+) create mode 100644 lib/edoc/doc/src/Makefile create mode 100644 lib/edoc/doc/src/book.xml create mode 100644 lib/edoc/doc/src/fascicules.xml create mode 100644 lib/edoc/doc/src/make.dep create mode 100644 lib/edoc/doc/src/notes.xml create mode 100644 lib/edoc/doc/src/part.xml create mode 100644 lib/edoc/doc/src/part_notes.xml create mode 100644 lib/edoc/doc/src/ref_man.xml (limited to 'lib/edoc/doc/src') diff --git a/lib/edoc/doc/src/Makefile b/lib/edoc/doc/src/Makefile new file mode 100644 index 0000000000..8d22e1c1da --- /dev/null +++ b/lib/edoc/doc/src/Makefile @@ -0,0 +1,139 @@ +# ``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) +APPLICATION=edoc + +# ---------------------------------------------------- +# Release directory specification +# ---------------------------------------------------- +RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN) + +# ---------------------------------------------------- +# Man page source directory (with .erl files) +# ---------------------------------------------------- +SRC_DIR = $(ERL_TOP)/lib/edoc/src +INC_DIR = $(ERL_TOP)/lib/edoc/include + +# ---------------------------------------------------- +# Target Specs +# ---------------------------------------------------- +XML_APPLICATION_FILES = ref_man.xml +XML_REF3_FILES = \ + edoc.xml \ + edoc_doclet.xml \ + edoc_extract.xml \ + edoc_layout.xml \ + edoc_lib.xml \ + edoc_run.xml + +XML_PART_FILES = part.xml part_notes.xml +XML_CHAPTER_FILES = chapter.xml +XML_NOTES_FILES = notes.xml + +BOOK_FILES = book.xml + +XML_FILES=\ + $(BOOK_FILES) $(XML_CHAPTER_FILES) \ + $(XML_PART_FILES) $(XML_REF3_FILES) $(XML_APPLICATION_FILES) \ + $(XML_NOTES_FILES) + +# ---------------------------------------------------- +INFO_FILE = ../../info + +HTML_FILES = \ + $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) \ + $(XML_PART_FILES:%.xml=$(HTMLDIR)/%.html) + +EXTRA_FILES = \ + $(DEFAULT_GIF_FILES) \ + $(DEFAULT_HTML_FILES) \ + $(XML_REF3_FILES:%.xml=$(HTMLDIR)/%.html) \ + $(XML_CHAPTER_FILES:%.xml=$(HTMLDIR)/%.html) \ + $(XML_NOTES_FILES:%.xml=$(HTMLDIR)/%.html) + +MAN3_FILES = $(XML_REF3_FILES:%.xml=$(MAN3DIR)/%.3) + +HTML_REF_MAN_FILE = $(HTMLDIR)/index.html + +TOP_PDF_FILE = $(PDFDIR)/$(APPLICATION)-$(VSN).pdf + + +# ---------------------------------------------------- +# FLAGS +# ---------------------------------------------------- +XML_FLAGS += +DVIPS_FLAGS += + +# ---------------------------------------------------- +# Targets +# ---------------------------------------------------- +$(HTMLDIR)/%.gif: %.gif + $(INSTALL_DATA) $< $@ + +docs: pdf html man + +$(TOP_PDF_FILE): $(XML_FILES) + +pdf: $(TOP_PDF_FILE) + +html: gifs $(HTML_REF_MAN_FILE) + +man: $(MAN3_FILES) + +$(XML_REF3_FILES): + docb_gen -def vsn $(EDOC_VSN) -includes $(INC_DIR) \ + $(SRC_DIR)/$(@:%.xml=%.erl) + +$(XML_CHAPTER_FILES): + docb_gen -chapter -def vsn $(EDOC_VSN) ../overview.edoc + +gifs: $(GIF_FILES:%=$(HTMLDIR)/%) + +debug opt: + +clean clean_docs: + rm -rf $(HTMLDIR)/* + rm -f $(MAN3DIR)/* + rm -f $(XML_REF3_FILES) $(XML_CHAPTER_FILES) *.html + rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo) + rm -f errs core *~ + + +# ---------------------------------------------------- +# Release Target +# ---------------------------------------------------- +include $(ERL_TOP)/make/otp_release_targets.mk + +release_docs_spec: docs + $(INSTALL_DIR) $(RELSYSDIR)/doc/pdf + $(INSTALL_DATA) $(TOP_PDF_FILE) $(RELSYSDIR)/doc/pdf + $(INSTALL_DIR) $(RELSYSDIR)/doc/html + $(INSTALL_DATA) $(HTMLDIR)/* \ + $(RELSYSDIR)/doc/html + $(INSTALL_DATA) $(INFO_FILE) $(RELSYSDIR) + $(INSTALL_DIR) $(RELEASE_PATH)/man/man3 + $(INSTALL_DATA) $(MAN3DIR)/* $(RELEASE_PATH)/man/man3 + +release_spec: diff --git a/lib/edoc/doc/src/book.xml b/lib/edoc/doc/src/book.xml new file mode 100644 index 0000000000..67b7cdb2d7 --- /dev/null +++ b/lib/edoc/doc/src/book.xml @@ -0,0 +1,48 @@ + + + + +
+ + 20062009 + Ericsson AB. All Rights Reserved. + + + 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 online 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. + + + + EDoc + + + + +
+ + + EDoc Application + + + + + + + + + + + + + + + + diff --git a/lib/edoc/doc/src/fascicules.xml b/lib/edoc/doc/src/fascicules.xml new file mode 100644 index 0000000000..1b9d6bc94d --- /dev/null +++ b/lib/edoc/doc/src/fascicules.xml @@ -0,0 +1,15 @@ + + + + + + User's Guide + + + Reference Manual + + + Release Notes + + + diff --git a/lib/edoc/doc/src/make.dep b/lib/edoc/doc/src/make.dep new file mode 100644 index 0000000000..b46e36314f --- /dev/null +++ b/lib/edoc/doc/src/make.dep @@ -0,0 +1,21 @@ +# ---------------------------------------------------- +# >>>> Do not edit this file <<<< +# This file was automaticly generated by +# /home/otp/bin/docdepend +# ---------------------------------------------------- + + +# ---------------------------------------------------- +# TeX files that the DVI file depend on +# ---------------------------------------------------- + +book.dvi: book.tex chapter.tex edoc.tex edoc_doclet.tex \ + edoc_extract.tex edoc_layout.tex edoc_lib.tex \ + edoc_run.tex part.tex ref_man.tex + +# ---------------------------------------------------- +# Source inlined when transforming from source to LaTeX +# ---------------------------------------------------- + +book.tex: ref_man.xml + diff --git a/lib/edoc/doc/src/notes.xml b/lib/edoc/doc/src/notes.xml new file mode 100644 index 0000000000..8fcbc8ec70 --- /dev/null +++ b/lib/edoc/doc/src/notes.xml @@ -0,0 +1,221 @@ + + + + +
+ + 20072009 + Ericsson AB. All Rights Reserved. + + + 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 online 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. + + + + EDoc Release Notes + otp_appnotes + nil + nil + nil + notes.xml +
+

This document describes the changes made to the EDoc + application.

+ +
Edoc 0.7.6.5 + +
Improvements and New Features + + +

+ The documentation is now built with open source tools + (xsltproc and fop) that exists on most platforms. One + visible change is that the frames are removed.

+

+ Own Id: OTP-8201

+ + +
+ +
+ +
Edoc 0.7.6.4 + +
Improvements and New Features + + +

+ Miscellaneous updates.

+

+ Own Id: OTP-8190

+ + +
+ +
+ +
Edoc 0.7.6.3 + +
Improvements and New Features + + +

The copyright notices have been updated.

+

+ Own Id: OTP-7851

+ + +
+ +
+ +
Edoc 0.7.6.2 + +
Improvements and New Features + + +

+ Minor updates.

+

+ Own Id: OTP-7642

+ + +
+ +
+ +
Edoc 0.7.6.1 + +
Fixed Bugs and Malfunctions + + +

+ Correction to work with new versions of STDLIB that no + longer has the erl_internal:obsolete/3 function.

+

+ Own Id: OTP-7539

+ + +
+ +
+ +
Edoc 0.7.6 + +
Improvements and New Features + + +

+ Minor changes.

+

+ Own Id: OTP-7388

+ + +
+ +
+ +
Edoc 0.7.5 + +
Improvements and New Features + + +

+ Minor updates, mostly cosmetic.

+

+ Own Id: OTP-7243

+ + +
+ +
+ +
+ Edoc 0.7.3 + +
+ Improvements and New Features + + +

Minor Makefile changes.

+

Own Id: OTP-6689

+ + +

Dialyzer warnings were eliminated.

+

Own Id: OTP-6737

+ + +
+
+ +
+ EDoc 0.7.2 + +
+ Fixed Bugs and Malfunctions + + +

Some missing files have been added: + , , +

+

Own Id: OTP-6457

+ + +
+ +
+ Improvements and New Features + + + + Undefined macros only cause warnings, not errors. + New, built-in macro. + Documented the and + generic tags. + Added recognition of as a wiki + equivalent for tags. + Added documentation about overview pages. + and are allowed as + separators in specs. + Corrected ambiguity in spec grammar (possible + incompatibility issue - parentheses may need to be added + in some cases, in existing code). + Experimental (and undocumented) support for + and tags and corresponding + annotations on parameters. + +

*** POTENTIAL INCOMPATIBILITY ***

+

Own Id: OTP-6568

+ + +
+
+ +
+ EDoc 0.7.1 + +
+ Fixed Bugs and Malfunctions + + +

Fixed some broken links in the documentation.

+

Own Id: OTP-6419

+ + +
+
+ +
+ EDoc 0.7.0 +

Miscellaneous changes.

+
+ + diff --git a/lib/edoc/doc/src/part.xml b/lib/edoc/doc/src/part.xml new file mode 100644 index 0000000000..a71b4eda13 --- /dev/null +++ b/lib/edoc/doc/src/part.xml @@ -0,0 +1,38 @@ + + + + +
+ + 20062009 + Ericsson AB. All Rights Reserved. + + + 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 online 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. + + + + EDoc User's Guide + + + + +
+ +

EDoc is the Erlang program documentation generator. + Inspired by the Javadoc (TM) tool for the Java (TM) programming + language, EDoc is adapted to the conventions of the Erlang world, + and has several features not found in Javadoc.

+ + + + diff --git a/lib/edoc/doc/src/part_notes.xml b/lib/edoc/doc/src/part_notes.xml new file mode 100644 index 0000000000..42fc39af42 --- /dev/null +++ b/lib/edoc/doc/src/part_notes.xml @@ -0,0 +1,38 @@ + + + + +
+ + 20072009 + Ericsson AB. All Rights Reserved. + + + 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 online 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. + + + + EDoc Release Notes + + + + +
+ +

EDoc is the Erlang program documentation generator. + Inspired by the Javadoc (TM) tool for the Java (TM) programming + language, EDoc is adapted to the conventions of the Erlang world, + and has several features not found in Javadoc.

+ + + + diff --git a/lib/edoc/doc/src/ref_man.xml b/lib/edoc/doc/src/ref_man.xml new file mode 100644 index 0000000000..619fbaa7ca --- /dev/null +++ b/lib/edoc/doc/src/ref_man.xml @@ -0,0 +1,43 @@ + + + + +
+ + 20062009 + Ericsson AB. All Rights Reserved. + + + 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 online 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. + + + + EDoc Reference Manual + + + + +
+ +

EDoc is the Erlang program documentation generator. + Inspired by the Javadoc (TM) tool for the Java (TM) programming + language, EDoc is adapted to the conventions of the Erlang world, + and has several features not found in Javadoc.

+ + + + + + + + + -- cgit v1.2.3