diff options
author | Erlang/OTP <[email protected]> | 2009-11-20 14:54:40 +0000 |
---|---|---|
committer | Erlang/OTP <[email protected]> | 2009-11-20 14:54:40 +0000 |
commit | 84adefa331c4159d432d22840663c38f155cd4c1 (patch) | |
tree | bff9a9c66adda4df2106dfd0e5c053ab182a12bd /lib/wx/doc/src | |
download | otp-84adefa331c4159d432d22840663c38f155cd4c1.tar.gz otp-84adefa331c4159d432d22840663c38f155cd4c1.tar.bz2 otp-84adefa331c4159d432d22840663c38f155cd4c1.zip |
The R13B03 release.OTP_R13B03
Diffstat (limited to 'lib/wx/doc/src')
-rw-r--r-- | lib/wx/doc/src/Makefile | 175 | ||||
-rw-r--r-- | lib/wx/doc/src/book.xml | 48 | ||||
-rw-r--r-- | lib/wx/doc/src/fascicules.xml | 15 | ||||
-rw-r--r-- | lib/wx/doc/src/make.dep | 13 | ||||
-rw-r--r-- | lib/wx/doc/src/notes.xml | 176 | ||||
-rw-r--r-- | lib/wx/doc/src/part.xml | 38 | ||||
-rw-r--r-- | lib/wx/doc/src/part_notes.xml | 37 | ||||
-rw-r--r-- | lib/wx/doc/src/ref_man.src.xml | 36 |
8 files changed, 538 insertions, 0 deletions
diff --git a/lib/wx/doc/src/Makefile b/lib/wx/doc/src/Makefile new file mode 100644 index 0000000000..d18daa753a --- /dev/null +++ b/lib/wx/doc/src/Makefile @@ -0,0 +1,175 @@ +# +# %CopyrightBegin% +# +# Copyright Ericsson AB 2008-2009. 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. +# +# %CopyrightEnd% +# + +# ---------------------------------------------------- +# Application version +# ---------------------------------------------------- +include ../../vsn.mk +include ../../config.mk +APPLICATION=wxErlang + +ErlMods = wx.erl wx_object.erl + +GenMods = $(shell ls ../../src/gen | grep 'wx[A-Z].*\.erl') \ + wx_misc.erl \ + glu.erl \ + gl.erl + +# GenMods = \ +# wx_misc.erl \ +# glu.erl \ +# gl.erl + + +ModsNoExt = $(ErlMods:%.erl=%) $(GenMods:%.erl=%) + +ifneq ($(INSIDE_ERLSRC),true) +# ---------------------------------------------------- +# Standalone release +# ---------------------------------------------------- +Mods = $(ErlMods:%=../../src/%) $(GenMods:%=../../src/gen/%) +HTML_FILES = $(ErlMods:%.erl=../html/%.html) $(GenMods:%.erl=../html/%.html) + +GIF_FILES = ../html/erlang.png +EXTRA_FILES = ../html/index.html \ + ../html/modules-frame.html \ + ../html/overview-summary.html \ + ../html/packages-frame.html + +HTML_STYLESHEET_FILES = ../html/stylesheet.css + +html: ../html/edoc-info + +docs: ../html/edoc-info + +../html/edoc-info: $(Mods) + @echo "Building documentation." + -mkdir -p ../html + erl -noshell -pa doc -run edoc_run application "wx" '"../.."' '[{private,true},no_packages,{dir,"../html"}, {sort_functions,false}]' + +clean: + rm -f *~ + (cd ../html; rm -f *.html *.css erlang.png edoc-info) + +opt debug: +else +# Release directory specification +# ---------------------------------------------------- +# Inside the erlang src +# ---------------------------------------------------- + +XML_APPLICATION_FILES = ref_man.xml +XML_REF3_FILES = $(ErlMods:%.erl=%.xml) $(GenMods:%.erl=%.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_NOTES_FILES) $(XML_APPLICATION_FILES) + + +# ---------------------------------------------------- +INFO_FILE = ../../info + +HTML_FILES = \ + $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) \ + $(XML_PART_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 +# ---------------------------------------------------- + +docs: pdf html man + +$(TOP_PDF_FILE): $(XML_FILES) + +pdf: $(TOP_PDF_FILE) + +html: gifs $(HTML_REF_MAN_FILE) + +man: $(MAN3_FILES) + +gifs: $(GIF_FILES:%=$(HTMLDIR)/%) + +xml: $(XML_REF3_FILES) $(XML_CHAPTER_FILES) + +ref_man.xml: ref_man.src.xml + @echo Preparing ref_man.xml + @cat ref_man.src.xml > ref_man.xml + @for d in $(ModsNoExt); do \ + echo " <xi:include href=\"$$d.xml\"/>" >> ref_man.xml ; \ + done + @echo "</application>" >> ref_man.xml + @echo + +$(ErlMods:%.erl=%.xml): + docb_gen -def vsn $(VSN) -sort_functions false ../../src/$(@:%.xml=%.erl) +$(GenMods:%.erl=%.xml): + docb_gen -def vsn $(VSN) -sort_functions false ../../src/gen/$(@:%.xml=%.erl) + +$(XML_CHAPTER_FILES): + docb_gen -chapter -def vsn $(VSN) ../overview.edoc + +debug opt: + +clean clean_docs: + rm -rf $(HTMLDIR)/* + rm -f $(MAN3DIR)/* + rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo) + rm -f errs core *~ ../html/edoc-info + rm -f $(XML_REF3_FILES) $(XML_CHAPTER_FILES) *.html + +# ---------------------------------------------------- +# 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) $(MAN3_FILES) $(RELEASE_PATH)/man/man3 + +release_spec: + +release_tests_spec: + +endif diff --git a/lib/wx/doc/src/book.xml b/lib/wx/doc/src/book.xml new file mode 100644 index 0000000000..d517892776 --- /dev/null +++ b/lib/wx/doc/src/book.xml @@ -0,0 +1,48 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE book SYSTEM "book.dtd"> + +<book xmlns:xi="http://www.w3.org/2001/XInclude"> + <header titlestyle="normal"> + <copyright> + <year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>wxErlang</title> + <prepared></prepared> + <docno></docno> + <date></date> + <rev></rev> + </header> + <insidecover> + </insidecover> + <pagetext>wxErlang</pagetext> + <preamble> + <contents level="2"></contents> + </preamble> + <parts lift="no"> + <xi:include href="part.xml"/> + </parts> + <applications> + <xi:include href="ref_man.xml"/> + </applications> + <releasenotes> + <xi:include href="notes.xml"/> + </releasenotes> + <listofterms></listofterms> + <index></index> +</book> + diff --git a/lib/wx/doc/src/fascicules.xml b/lib/wx/doc/src/fascicules.xml new file mode 100644 index 0000000000..1b9d6bc94d --- /dev/null +++ b/lib/wx/doc/src/fascicules.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE fascicules SYSTEM "fascicules.dtd"> + +<fascicules> + <fascicule file="part" href="part_frame.html" entry="no"> + User's Guide + </fascicule> + <fascicule file="ref_man" href="ref_man_frame.html" entry="yes"> + Reference Manual + </fascicule> + <fascicule file="part_notes" href="part_notes_frame.html" entry="no"> + Release Notes + </fascicule> +</fascicules> + diff --git a/lib/wx/doc/src/make.dep b/lib/wx/doc/src/make.dep new file mode 100644 index 0000000000..91001be438 --- /dev/null +++ b/lib/wx/doc/src/make.dep @@ -0,0 +1,13 @@ +# ---------------------------------------------------- +# >>>> 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 part.tex + diff --git a/lib/wx/doc/src/notes.xml b/lib/wx/doc/src/notes.xml new file mode 100644 index 0000000000..f9f16defd3 --- /dev/null +++ b/lib/wx/doc/src/notes.xml @@ -0,0 +1,176 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE chapter SYSTEM "chapter.dtd"> + +<chapter> + <header> + <copyright> + <year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>wxErlang Release Notes</title> + <prepared>otp_appnotes</prepared> + <docno>nil</docno> + <date>nil</date> + <rev>nil</rev> + <file>notes.xml</file> + </header> + <p>This document describes the changes made to the wxErlang + application.</p> + +<section><title>Wx 0.98.4</title> + + <section><title>Improvements and New Features</title> + <list> + <item> + <p>Added wx_object improvements from Mazen.</p> <p>Fixed + pid issues, reported by Mazen.</p> <p>Added wxLogNull + class, reported by Amit Murthy.</p> <p>Various configure + fixes.</p> + <p> + Own Id: OTP-8243 Aux Id: seq11418 </p> + </item> + <item> + <p> + 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.</p> + <p> + Own Id: OTP-8250</p> + </item> + <item> + <p> + wx now builds with wxWidgets 2.8.4 or a later 2.8 + release, thanks Nico Kruber.</p> + <p> + Own Id: OTP-8292</p> + </item> + </list> + </section> + +</section> + +<section><title>Wx 0.98.3</title> + + <section><title>Fixed Bugs and Malfunctions</title> + <list> + <item> + <p> + Added wxListCtrl sorting and build fixes supplied by Paul + Hampson. Thanks.</p> + <p> + Own Id: OTP-8126</p> + </item> + </list> + </section> + + + <section><title>Improvements and New Features</title> + <list> + <item> + <p>wxHtmlWindow class implemented.</p> <p>All exceptions + from callbacks are now catched and written to the + log.</p> <p>Some defines where wrong in 'wx.hrl'.</p> + <p><c>wx:batch/1</c> and friends could hang forever if + for instance a breakpoint was set inside the fun. That + caused all wx applications to hang.</p> <p>Added missing + wxAuiPaneInfo constructor and destructor.</p> <p>Added + wxAuiNotebookEvent and wxAuiManagerEvent.</p> <p>Calling + non supported wxWidgets functions hanged instead of + crashed.</p> <p>Update OpenGL to version 3.1 and added + some of the missing glu functions.</p> <p>Fixed + wxRadioBox which inherited the wrong class, thanks Atilla + Erdodi.</p> + <p> + Own Id: OTP-8083</p> + </item> + <item> + <p> + Removed some of the automatic garbage collecting after + application exit, user will get a warning instead so he + can correct the code.</p> + <p> + Own Id: OTP-8138</p> + </item> + </list> + </section> + +</section> + +<section><title>Wx 0.98.2</title> + + <section><title>Improvements and New Features</title> + <list> + <item> + <p>Olle Mattson have made a large demo, see + <c>examples/demo/</c>, that triggered the following bugs + and new features:</p> <p>New book controls.</p> <p>Added + wxToolbar:addTool/6.</p> <p>Empty binaries will be used + to indicate NULL where applicable.</p> + <p> + Own Id: OTP-7943</p> + </item> + <item> + <p>Applied patch from Nico Kruber, + which fixes building on some wxwidgets installations. + </p> + <p>Open source</p> + </item> + </list> + </section> + +</section> + + <section><title>Wx 0.98.1</title> + + <section><title>Improvements and New Features</title> + <list> + <item> + <p>Added <c>xrcctrl/3</c> to wxXmlResource and added a + resource example.</p> <p>Added several event types and + events records and fixed a couple of event related + bugs.</p> <p>Event callbacks can now use + <c>wxEvtHandler:connect/2</c>.</p> <p>Error handling and + debugging aid have been improved.</p> <p>Added + wxSplitterWindow and wxGauge:pulse and a couple of + missing macros in <c>wx.hrl</c>.</p> <p>Thanks to Steve + Davis for feedback and bug reports.</p> + <p> + Own Id: OTP-7875</p> + </item> + </list> + </section> + +</section> + + + <section><title>Wx 0.98</title> + + <section><title>Improvements and New Features</title> + <list> + <item> + <p> + A first beta release of wxErlang.</p> + <p> + Own Id: OTP-7859</p> + </item> + </list> + </section> + +</section> + +</chapter> + diff --git a/lib/wx/doc/src/part.xml b/lib/wx/doc/src/part.xml new file mode 100644 index 0000000000..168add1a3c --- /dev/null +++ b/lib/wx/doc/src/part.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE part SYSTEM "part.dtd"> + +<part xmlns:xi="http://www.w3.org/2001/XInclude"> + <header> + <copyright> + <year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>wxErlang User's Guide</title> + <prepared>Dan Gudmundsson</prepared> + <docno></docno> + <date>2009-03-09</date> + <rev>1.0</rev> + <file>part.xml</file> + </header> + <description> + <p>The <em>wxErlang</em> application is an api for writing graphical user + interfaces with wxWidgets. + </p> + </description> + <xi:include href="chapter.xml"/> +</part> + diff --git a/lib/wx/doc/src/part_notes.xml b/lib/wx/doc/src/part_notes.xml new file mode 100644 index 0000000000..539ced5f1d --- /dev/null +++ b/lib/wx/doc/src/part_notes.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE part SYSTEM "part.dtd"> + +<part xmlns:xi="http://www.w3.org/2001/XInclude"> + <header> + <copyright> + <year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>wxErlang Release Notes</title> + <prepared></prepared> + <docno></docno> + <date></date> + <rev></rev> + </header> + <description> + <p>The <em>wxErlang</em> application is an api for writing graphical user + interfaces with wxWidgets. + </p> + </description> + <xi:include href="notes.xml"/> +</part> + diff --git a/lib/wx/doc/src/ref_man.src.xml b/lib/wx/doc/src/ref_man.src.xml new file mode 100644 index 0000000000..77fd16b050 --- /dev/null +++ b/lib/wx/doc/src/ref_man.src.xml @@ -0,0 +1,36 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE application SYSTEM "application.dtd"> + +<application xmlns:xi="http://www.w3.org/2001/XInclude"> + <header> + <copyright> + <year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + 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. + + </legalnotice> + + <title>wxErlang Reference Manual</title> + <prepared></prepared> + <docno></docno> + <date></date> + <rev></rev> + </header> + <description> + <p>The <em>wxErlang</em> application is an api for writing graphical user + interfaces with wxWidgets. + </p> + </description> + + |