README
1API GENERATION:
2 Most of the code in wx is generated.
3 Users of wxErlang should not normally need to regenerate the generated code,
4 as it is checked in by wxErlang developers, when changes are made.
5
6 Code checked in is currently generated from wxwidgets 2.8.12.
7
8REQUIREMENTS:
9 The code generation requires doxygen (1.4.6) which is
10 used to parse wxWidgets c++ headers and generate xml files (in
11 wx_xml/).
12 2017-08-16 doxygen 1.8.11 is working with WXGTK_DIR=/ldisk/src/wxWidgets-2.8.12/include
13
14 2012-02-09 doxygen 1.7.4 is working fine
15
16 2008-09-29 doxygen 1.4.6 is required.
17 Later versions of Doxygen - up to 1.5.6 at least - have a bug in the xml generation
18 which causes us problems. This has been logged and we are waiting for a fix.
19
20 doxygen 1.6.1 and doxygen 1.6.3 might work but is not what I use, i.e.
21 review the diffs.
22
23CONFIGURATION:
24 wxapi.conf contains the specification to the code generator. The code
25 generator reads the specification and parses the xml files and
26 produces the erlang and the 'C' code.
27
28 Adding/changing stuff/classes should be done by updating wxapi.conf
29 and running make. Sometimes the code generator will require changes,
30 I havn't thought of everything yet.
31
32RUNNING:
33 I use the following alias wxgen='make WXGTK_DIR=/opt/local/include/wx-2.8/ GL_DIR=/home/dgud/opengl'
34
35 I keep the opengl headers separate so I don't go backwards in version when generating the code
36 from another machine.
37
38 Also gl.h from different vendors differ so keep it consistent,
39 I have used mesa's gl.h and the glext.h from opengl.org
40 (version see GL_GLEXT_VERSION in gl.hrl)
41
42 I also get the xml documentation from opengl.org (subversion) and place it in
43 api_gen/gl_man2 (all old functions) and api_gen/gl_man4 (all the new functions).
44
45CONTRIBUTION:
46 Send me patches
47