aboutsummaryrefslogtreecommitdiffstats
path: root/lib/wx/api_gen/README
blob: 3c49f7b2a5be5456d37de23182f9c458ce8d7719 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
API GENERATION:
    Most of the code in wx is generated.  
    Users of wxErlang should not normally need to regenerate the generated code, 
    as it is checked in by wxErlang developers, when changes are made.
    2008-09-29 Code checked in is currently generated from wxwidgets 2.8.7.

REQUIREMENTS:
    The code generation requires doxygen (1.4.6) which is
    used to parse wxWidgets c++ headers and generate xml files (in
    wx_xml/).

    (2008-09-29 doxygen 1.4.6 is required.
    Later versions of Doxygen - up to 1.5.6 at least - have a bug in the xml generation
    which causes us problems. This has been logged and we are waiting for a fix.)

CONFIGURATION:
    wxapi.conf contains the specification to the code generator.  The code
    generator reads the specification and parses the xml files and
    produces the erlang and the 'C' code.

    Adding/changing stuff/classes should be done by updating wxapi.conf
    and running make. Sometimes the code generator will require changes,
    I havn't thought of everything yet.

CONTRIBUTION:
    Send me patches or update the svn version.