Changeset 823


Ignore:
Timestamp:
Apr 21, 2006, 6:27:43 PM (14 years ago)
Author:
Sam Hocevar
Message:
  • Added AUTHORS, THANKS, NEWS and TODO to the Doxygen documentation. Moved the main documentation page from caca.h to a separate file.
Location:
libcaca/trunk
Files:
1 added
7 edited

Legend:

Unmodified
Added
Removed
  • libcaca/trunk/AUTHORS

    r563 r823  
    1 $Id$
     1/* $Id$ */ /** \page authors Authors
    22
    33Sam Hocevar <sam@zoy.org>
    4  o main programmer
     4 - main programmer
    55
    66Jean-Yves Lamoureux <jylam@lnxscene.org>
    7  o cacaball
    8  o OpenGL driver
    9  o Pypycaca Python wrapper
    10  o exporters
    11  o network driver
     7 - cacaball
     8 - OpenGL driver
     9 - Pypycaca Python wrapper
     10 - exporters
     11 - network driver
    1212
    1313John Beppu <beppu@lbox.org>
    14  o Term::Caca Perl wrapper
     14 - Term::Caca Perl wrapper
    1515
     16*/
  • libcaca/trunk/NEWS

    r362 r823  
    1 $Id$
     1/* $Id$ */ /** \page news News
    22
    3 Changes between 0.8 and 0.9:
    4 ----------------------------
     3\section news0_9 Changes between 0.8 and 0.9
    54
    6   * fix for a buffer overflow in the line rendering
    7   * fixed resizing in the ncurses and slang drivers
    8   * aspect ratio and finer zoom support in cacaview
    9   * minor compilation fixes
     5 - fix for a buffer overflow in the line rendering
     6 - fixed resizing in the ncurses and slang drivers
     7 - aspect ratio and finer zoom support in cacaview
     8 - minor compilation fixes
    109
    11 Changes between 0.7 and 0.8:
    12 ----------------------------
     10\section news0_8 Changes between 0.7 and 0.8
    1311
    14   * window resizing support
    15   * native Win32 port
    16   * autorepeat emulation in the ncurses and slang drivers
    17   * support for more keycodes in the ncurses and slang drivers
    18   * cacaplas, a plasma animation example
    19   * cacamoir, a moiré circles animation example
    20   * MSVC project file
     12 - window resizing support
     13 - native Win32 port
     14 - autorepeat emulation in the ncurses and slang drivers
     15 - support for more keycodes in the ncurses and slang drivers
     16 - cacaplas, a plasma animation example
     17 - cacamoir, a moiré circles animation example
     18 - MSVC project file
    2119
    22 Changes between 0.6 and 0.7:
    23 ----------------------------
     20\section news0_7 Changes between 0.6 and 0.7
    2421
    25   * many bugfixes in the event handling
    26   * cacaball, a metaball animation example
     22 - many bugfixes in the event handling
     23 - cacaball, a metaball animation example
    2724
    28 Changes between 0.5 and 0.6:
    29 ----------------------------
     25\section news0_6 Changes between 0.5 and 0.6
    3026
    31   * 30% speed increase in the bitmap rendering routine
    32   * mouse support and various speed optimisations in the X11 driver
    33   * X11 is now the preferred driver
    34   * improved documentation
    35   * minor bugfixes
     27 - 30% speed increase in the bitmap rendering routine
     28 - mouse support and various speed optimisations in the X11 driver
     29 - X11 is now the preferred driver
     30 - improved documentation
     31 - minor bugfixes
    3632
    37 Changes between 0.4 and 0.5:
    38 ----------------------------
     33\section news0_5 Changes between 0.4 and 0.5
    3934
    40   * palette optimisation for the S-Lang driver to work around the colour pair
     35 - palette optimisation for the S-Lang driver to work around the colour pair
    4136    shortage bug
    42   * minor compilation fix
     37 - minor compilation fix
    4338
    44 Changes between 0.3 and 0.4:
    45 ----------------------------
     39\section news0_4 Changes between 0.3 and 0.4
    4640
    47   * preliminary X11 graphics driver
    48   * support for simultaneously compiled-in drivers
    49   * honour the CACA_DRIVER, CACA_GEOMETRY and CACA_FONT environment variables
    50   * more documentation
     41 - preliminary X11 graphics driver
     42 - support for simultaneously compiled-in drivers
     43 - honour the CACA_DRIVER, CACA_GEOMETRY and CACA_FONT environment variables
     44 - more documentation
    5145
    52 Changes between 0.2 and 0.3:
    53 ----------------------------
     46\section news0_3 Changes between 0.2 and 0.3
    5447
    55   * antialiasing support
    56   * dithering, antialiasing and background mode can now be selected at
     48 - antialiasing support
     49 - dithering, antialiasing and background mode can now be selected at
    5750    runtime or in the environment using the CACA_BACKGROUND, CACA_DITHERING
    5851    and CACA_ANTIALIASING variables
    59   * alpha channel support in cacaview
    60   * BMP loading support in cacaview even if Imlib2 is not present
    61   * cacafire, a libcaca port of aafire
     52 - alpha channel support in cacaview
     53 - BMP loading support in cacaview even if Imlib2 is not present
     54 - cacafire, a libcaca port of aafire
    6255
    63 Changes between 0.1 and 0.2:
    64 ----------------------------
     56\section news0_2 Changes between 0.1 and 0.2
    6557
    66   * rendering now uses 256 colour pairs instead of 16
    67   * mouse support for ncurses
    68   * ncurses is now the preferred backend
    69   * arbitrary color depth and bitmasks in the bitmap renderer
    70   * cacaview, an image viewer based on libcaca
     58 - rendering now uses 256 colour pairs instead of 16
     59 - mouse support for ncurses
     60 - ncurses is now the preferred backend
     61 - arbitrary color depth and bitmasks in the bitmap renderer
     62 - cacaview, an image viewer based on libcaca
    7163
    72 New in 0.1
    73 ----------
     64\section news_0_1 New in 0.1
    7465
    75   * initial release
    76   * slang, ncurses and conio drivers
    77   * basic line, box, ellipse and triangle primitives
    78   * colour bitmap blitting
     66 - initial release
     67 - slang, ncurses and conio drivers
     68 - basic line, box, ellipse and triangle primitives
     69 - colour bitmap blitting
    7970
     71*/
  • libcaca/trunk/THANKS

    r591 r823  
    1 $Id$
     1/* $Id$ */ /** \page thanks Thanks
    22
    3 Bugfixes and improvements
    4 =========================
    5 Gildas Bazin <gbazin@netcourrier.com> - win32 driver improvements
    6 Jari Komppa <jari.komppa at gmail> - win32 speed improvements
     3\section thanks1 Bugfixes and improvements
    74
    8 Reused code
    9 ===========
    10 Jan Hubicka <hubicka@freesoft.cz> - aafire
    11 Michele Bini <mibin@tin.it> - original SDL plasma
    12 Free Software Foundation, Inc. - multiboot.S
     5- Gildas Bazin <gbazin@netcourrier.com> - win32 driver improvements
     6- Jari Komppa <jari.komppa at gmail> - win32 speed improvements
    137
    14 Porters and packagers
    15 =====================
    16 Derk-Jan Hartman <thedj@users.sourceforge.net> - Gentoo ebuild file
    17 Ladislav Hagara <hgr@vabo.cz> - Source Mage spell
    18 Philip Balinov - Slackware package
    19 Richard Zidlicky <rz@linux-m68k.org> - rpm specfile
    20 Thomas Klausner <wiz@NetBSD.org> - NetBSD port maintainer
    21 Vincent Tantardini <vinc@FreeBSD-fr.org> - FreeBSD port maintainer
     8\section thanks2 Reused code
     9
     10- Jan Hubicka <hubicka@freesoft.cz> - aafire
     11- Michele Bini <mibin@tin.it> - original SDL plasma
     12- Free Software Foundation, Inc. - multiboot.S
     13
     14\section thanks3 Porters and packagers
     15
     16- Derk-Jan Hartman <thedj@users.sourceforge.net> - Gentoo ebuild file
     17- Ladislav Hagara <hgr@vabo.cz> - Source Mage spell
     18- Philip Balinov - Slackware package
     19- Richard Zidlicky <rz@linux-m68k.org> - rpm specfile
     20- Thomas Klausner <wiz@NetBSD.org> - NetBSD port maintainer
     21- Vincent Tantardini <vinc@FreeBSD-fr.org> - FreeBSD port maintainer
     22
     23*/
  • libcaca/trunk/TODO

    r806 r823  
    1 $Id$
     1/* $Id$ */ /** \page todo TODO list
    22
    3 libcucul
    4 ========
     3\section libcucul libcucul
    54
    6   API-dependent stuff
    7   -------------------
     5  \subsection dep API-dependent stuff
    86
    9    o all the sprite stuff (loading, saving, blitting, transparency
     7  - all the sprite stuff (loading, saving, blitting, transparency
    108     support, background colour support, thinking of a storage format,
    119     etc.)
    1210
    13    o Or maybe, instead of doing shit with the sprites, just allow canvases
     11  - Or maybe, instead of doing shit with the sprites, just allow canvases
    1412     to have several buffers, allow to change the active buffer, and treat
    1513     sprites like that.
    1614
    17    o ASCII/ANSI art loading functions (maybe load them as sprites)
     15  - ASCII/ANSI art loading functions (maybe load them as sprites)
    1816
    1917
    20   API-independent stuff
    21   ---------------------
     18  \subsection indep API-independent stuff
    2219
    23    o support for transparency (CUCUL_COLOR_TRANSPARENT)
     20  - support for transparency (CUCUL_COLOR_TRANSPARENT)
    2421
    25    o Brightness, contrast support for bitmaps (the functions are here, we
     22  - Brightness, contrast support for bitmaps (the functions are here, we
    2623     just need to fill them)
    2724
    28    o Error distribution dithering
     25  - Error distribution dithering
    2926
    30    o Add a random factor to the random ditherer. No need to change the API
     27  - Add a random factor to the random ditherer. No need to change the API
    3128     for that, we can just pass "random:10" instead of "random" to the
    3229     cucul_set_bitmap_dithering() function.
    3330
    34    o Implement the colour modes set in cucul_set_bitmap_color(). For the
     31  - Implement the colour modes set in cucul_set_bitmap_color(). For the
    3532     moment only "full16" and "16" are implemented.
    3633
    37    o Fix the thin ellipse rendering (currently it's only |s and -s, we
     34  - Fix the thin ellipse rendering (currently it's only |s and -s, we
    3835     could make them smoother by using ' ` , etc).
    3936
    40    o support for double width glyphs (also needs some libcaca changes)
     37  - support for double width glyphs (also needs some libcaca changes)
    4138
    42    o better mask support in cucul_blit()
     39  - better mask support in cucul_blit()
    4340
    44    o factor Unicode character conversions, especially UCS4 -> UTF-8
     41  - factor internal Unicode character conversions, especially UCS4 -> UTF-8
     42
     43  - optimise exporters so that they do not allocate huge blocks of memory
     44     when they only need half of it.
    4545
    4646
    47 libcaca
    48 =======
     47\section libcaca libcaca
    4948
    50   API-dependent stuff
    51   -------------------
     49  \subsection dep API-dependent stuff
    5250
    53    o text edit widget with cursor support (I'm unsure about this, it
     51  - text edit widget with cursor support (I'm unsure about this, it
    5452     seems pretty difficult)
    5553
    5654
    57   API-independent stuff
    58   ---------------------
     55  \subsection indep API-independent stuff
    5956
    60    o Write a Linux console output
     57  - Write a Linux console output
    6158
    62    o Better keyboard driver in an X terminal, see
     59  - Better keyboard driver in an X terminal, see
    6360     http://groups.yahoo.com/group/zepp/message/381
    6461
    65    o Unicode support for X11 (maybe through Xft)
     62  - Unicode support for X11 (maybe through Xft)
    6663
    67    o fix Unicode support for ncurses
     64  - fix Unicode support for ncurses
    6865
    69    o Unicode support for GL
     66  - Unicode support for GL
    7067
    71    o and Jylam wants a framebuffer output
     68  - and Jylam wants a framebuffer output
    7269
    7370
    74 Language bindings
    75 =================
     71\section bindings Language bindings
    7672
    77   Needed
    78   ------
     73  \subsection needed Needed
    7974
    80    o Fix Python
     75  - Fix Python
    8176
    82    o Fix Perl
     77  - Fix Perl
    8378
    84    o C# (it's the next big thing, believe me)
     79  - C# (it's the next big thing, believe me)
    8580
    86    o PHP (together with the HTML output it would allow for nice web
     81  - PHP (together with the HTML output it would allow for nice web
    8782     applications)
    8883
    8984
    90   Not that important
    91   ------------------
     85  \subsection notimp Not that important
    9286
    93    o Ruby
     87  - Ruby
    9488
    95    o Java
     89  - Java
    9690
    9791
    98 Kernel mode
    99 ===========
     92\section kernel Kernel mode
    10093
    101    o keyboard support
     94  - keyboard support
    10295
    103    o printf/fprintf are missing
     96  - printf/fprintf are missing
    10497
    105    o Improve malloc/free so that we can reuse freed memory
     98  - Improve malloc/free so that we can reuse freed memory
    10699
    107100
    108 Documentation
    109 =============
     101\section doc Documentation
    110102
    111    o Write a tutorial.
     103  - Write a tutorial.
    112104
    113    o Draw a nicer logo
     105  - Draw a nicer logo
    114106
    115107
    116 Applications
    117 ============
     108\section apps Applications
    118109
    119   cacaview
    120   --------
     110  \section cacaview cacaview
    121111
    122    o File browser
     112  - File browser
    123113
    124    o open ANSI files
     114  - open ANSI files
    125115
    126    o save in different formats
     116  - save in different formats
    127117
    128118
    129   cacadraw
    130   --------
     119  \section cacadraw cacadraw
    131120
    132    o Does not exist yet, but I want it. A modern ANSI editor that can also
     121  - Does not exist yet, but I want it. A modern ANSI editor that can also
    133122     do Unicode.
    134123
    135124
    136   CUCUlet
    137   -------
     125  \section cuculet CUCUlet
    138126
    139    o Does not exist yet, but I want it. A replacement for FIGlet that can
     127  - Does not exist yet, but I want it. A replacement for FIGlet that can
    140128     also do Unicode
    141129
    142    o Colour support, of course: outputs to IRC, ANSI, HTML...
     130  - Colour support, of course: outputs to IRC, ANSI, HTML...
    143131
    144    o Can open FIGlet fonts
     132  - Can open FIGlet fonts
    145133
     134*/
  • libcaca/trunk/caca/caca.h

    r819 r823  
    1919 *  This header contains the public types and functions that applications
    2020 *  using \e libcaca may use.
    21  */
    22 
    23 /** \mainpage libcaca developer documentation
    24  *
    25  *  \section intro Introduction
    26  *
    27  *  \e libcaca is a graphics library that outputs text instead of pixels,
    28  *  so that it can work on older video cards or text terminals. It is not
    29  *  unlike the famous AAlib library. \e libcaca can use almost any virtual
    30  *  terminal to work, thus it should work on all Unix systems (including
    31  *  Mac OS X) using either the slang library or the ncurses library, on DOS
    32  *  using the conio library, and on Windows systems using either slang or
    33  *  ncurses (through Cygwin emulation) or conio. There is also a native X11
    34  *  driver, and an OpenGL driver (through freeglut) that does not require a
    35  *  text terminal. For machines without a screen, the raw driver can be used
    36  *  to send the output to another machine, using for instance cacaserver.
    37  *
    38  *  \e libcaca is free software, released under the Do What The Fuck You
    39  *  Want To Public License. This ensures that no one, not even the \e libcaca
    40  *  developers, will ever have anything to say about what you do with the
    41  *  software. It used to be licensed under the GNU Lesser General Public
    42  *  License, but that was not free enough.
    43  *
    44  *  \section api The libcaca API
    45  *
    46  *  \e libcaca relies on a low-level, device independent library, called
    47  *  \e libcucul. \e libcucul can be used alone as a simple ASCII and/or
    48  *  Unicode compositing canvas.
    49  *
    50  *  The complete \e libcucul and \e libcaca programming interface is
    51  *  available from the cucul.h and caca.h headers.
    52  *
    53  *  \section env Environment variables
    54  *
    55  *  Some environment variables can be used to change the behaviour of
    56  *  \e libcaca without having to modify the program which uses them. These
    57  *  variables are:
    58  *
    59  *  \li \b CACA_DRIVER: set the backend video driver. In order of preference:
    60  *      - \c conio uses the DOS conio.h interface.
    61  *      - \c ncurses uses the ncurses library.
    62  *      - \c slang uses the S-Lang library.
    63  *      - \c x11 uses the native X11 driver.
    64  *      - \c gl uses freeglut and opengl libraries.
    65  *      - \c raw outputs to the standard output instead of rendering the
    66  *        canvas. This is can be used together with cacaserver.
    67  *
    68  *  \li \b CACA_GEOMETRY: set the video display size. The format of this
    69  *      variable must be XxY, with X and Y being integer values. This option
    70  *      currently works with the network, X11 and GL drivers.
    71  *
    72  *  \li \b CACA_FONT: set the rendered font. The format of this variable is
    73  *      implementation dependent, but since it currently only works with the
    74  *      X11 driver, an X11 font name such as "fixed" or "5x7" is expected.
    7521 */
    7622
  • libcaca/trunk/doc/Makefile.am

    r772 r823  
    11# $Id$
    22
    3 EXTRA_DIST = doxygen.cfg.in footer.html header.html $(man_MANS)
     3EXTRA_DIST = doxygen.cfg.in footer.html header.html libcaca.dox $(man_MANS)
    44
    55man_MANS = caca-config.1 cacafire.1 cacaview.1
  • libcaca/trunk/doc/doxygen.cfg.in

    r772 r823  
    245245# If set to NO only classes defined in header files are included.
    246246
    247 EXTRACT_LOCAL_CLASSES  = YES
     247EXTRACT_LOCAL_CLASSES  = NO
    248248
    249249# This flag is only useful for Objective-C code. When set to YES local
     
    320320# declaration order.
    321321
    322 SORT_MEMBER_DOCS       = YES
     322SORT_MEMBER_DOCS       = NO
    323323
    324324# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
     
    382382# list will mention the files that were used to generate the documentation.
    383383
    384 SHOW_USED_FILES        = YES
     384SHOW_USED_FILES        = NO
    385385
    386386# If the sources in your project are distributed over multiple directories
     
    460460# with spaces.
    461461
    462 INPUT                  = @top_srcdir@/cucul \
     462INPUT                  = @top_srcdir@ \
     463                         @top_srcdir@/doc \
     464                         @top_srcdir@/cucul \
    463465                         @top_srcdir@/caca
    464466
     
    470472# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
    471473
    472 FILE_PATTERNS          = *.c \
    473                          cucul.h \
    474                          caca.h
     474FILE_PATTERNS          = *.dox *.c cucul.h caca.h \
     475                         NEWS AUTHORS THANKS TODO
    475476
    476477# The RECURSIVE tag can be used to turn specify whether or not subdirectories
     
    478479# If left blank NO is used.
    479480
    480 RECURSIVE              = YES
     481RECURSIVE              = NO
    481482
    482483# The EXCLUDE tag can be used to specify files and/or directories that should
     
    484485# subdirectory from a directory tree whose root is specified with the INPUT tag.
    485486
    486 EXCLUDE                = ../src/config.h
     487EXCLUDE                =
    487488
    488489# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
     
    598599# which an include is specified. Set to NO to disable this.
    599600
    600 VERBATIM_HEADERS       = YES
     601VERBATIM_HEADERS       = NO
    601602
    602603#---------------------------------------------------------------------------
     
    713714# the value YES disables it.
    714715
    715 DISABLE_INDEX          = NO
     716DISABLE_INDEX          = YES
    716717
    717718# This tag can be used to set the number of enum values (range [1..20])
     
    809810# in the output.
    810811
    811 LATEX_HIDE_INDICES     = NO
     812LATEX_HIDE_INDICES     = YES
    812813
    813814#---------------------------------------------------------------------------
Note: See TracChangeset for help on using the changeset viewer.