Changeset 205


Ignore:
Timestamp:
Nov 22, 2003, 1:45:25 PM (17 years ago)
Author:
Sam Hocevar
Message:
  • src/: + Doxygenated a few things.
Location:
libcaca/trunk/src
Files:
12 edited

Legend:

Unmodified
Added
Removed
  • libcaca/trunk/src/blit.c

    r204 r205  
    33 *   Copyright (c) 2002, 2003 Sam Hocevar <sam@zoy.org>
    44 *                 All Rights Reserved
    5  *
    6  *   $Id$
    75 *
    86 *   This library is free software; you can redistribute it and/or
     
    2018 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
    2119 *   02111-1307  USA
     20 */
     21
     22/**  \file blit.c
     23 *   \version \$Id$
     24 *   \author Sam Hocevar <sam@zoy.org>
     25 *   \brief Bitmap functions
     26 *
     27 *   This file contains bitmap blitting functions.
    2228 */
    2329
  • libcaca/trunk/src/box.c

    r192 r205  
    33 *   Copyright (c) 2002, 2003 Sam Hocevar <sam@zoy.org>
    44 *                 All Rights Reserved
    5  *
    6  *   $Id$
    75 *
    86 *   This library is free software; you can redistribute it and/or
     
    2018 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
    2119 *   02111-1307  USA
     20 */
     21
     22/**  \file box.c
     23 *   \version \$Id$
     24 *   \author Sam Hocevar <sam@zoy.org>
     25 *   \brief Simple box drawing functions
     26 *
     27 *   This file contains box drawing functions, both filled and outline.
    2228 */
    2329
  • libcaca/trunk/src/caca.c

    r200 r205  
    33 *   Copyright (c) 2002, 2003 Sam Hocevar <sam@zoy.org>
    44 *                 All Rights Reserved
    5  *
    6  *   $Id$
    75 *
    86 *   This library is free software; you can redistribute it and/or
     
    2018 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
    2119 *   02111-1307  USA
     20 */
     21
     22/**  \file caca.c
     23 *   \version \$Id$
     24 *   \author Sam Hocevar <sam@zoy.org>
     25 *   \brief Main \e libcaca functions
     26 *
     27 *   This file contains the main functions used by \e libcaca applications to
     28 *   initialise the library, get the screen properties, set the framerate and
     29 *   so on.
    2230 */
    2331
  • libcaca/trunk/src/caca.h

    r204 r205  
    33 *   Copyright (c) 2002, 2003 Sam Hocevar <sam@zoy.org>
    44 *                 All Rights Reserved
    5  *
    6  *   $Id$
    75 *
    86 *   This library is free software; you can redistribute it and/or
     
    2220 */
    2321
     22/**  \file caca.h
     23 *   \version \$Id$
     24 *   \author Sam Hocevar <sam@zoy.org>
     25 *   \brief The \e libcaca public header.
     26 *
     27 *   This header contains the public types and functions that applications
     28 *   using \e libcaca may use.
     29 */
     30
     31/**  \mainpage libcaca developer documentation
     32 *
     33 *   \section intro Introduction
     34 *
     35 *   \e libcaca is a graphics library that outputs text instead of pixels,
     36 *   so that it can work on older video cards or text terminals. It is not
     37 *   unlike the famous AAlib library. libcaca needs a terminal to work,
     38 *   thus it should work on all Unix systems (including Mac OS X) using
     39 *   either the slang library or the ncurses library, on DOS using the conio
     40 *   library, and on Windows systems using either slang or ncurses (through
     41 *   Cygwin emulation) or conio.
     42 *
     43 *   \e libcaca is free software, released under the GNU Lesser General
     44 *   Public License. This ensures that \e libcaca will always remain free
     45 *   software.
     46 *
     47 *   \section api The libcaca API
     48 *
     49 *   The complete \e libcaca programming interface is available from the
     50 *   caca.h file.
     51 */
     52
    2453#ifndef __CACA_H__
    2554#define __CACA_H__
     
    3059#endif
    3160
    32 /*
    33  * Colors
     61/**
     62 * The colour definitions to be used with caca_set_color().
    3463 */
    3564enum caca_color
     
    5382};
    5483
    55 /*
    56  * Dithering modes
     84/**
     85 * The dithering modes to be used with caca_set_dithering().
    5786 */
    5887enum caca_dithering
     
    6392};
    6493
    65 /*
    66  * Events
     94/**
     95 * The event types returned by caca_get_event().
    6796 */
    6897enum caca_event
     
    74103};
    75104
    76 /*
    77  * Keys
     105/**
     106 * The special key values returned by caca_get_event().
    78107 */
    79108enum caca_key
     
    102131
    103132/*
    104  * Internal types
    105  */
    106 struct caca_sprite;
    107 struct caca_bitmap;
    108 
    109 /*
    110133 * Basic functions
    111134 */
     
    165188 * Sprite handling
    166189 */
     190struct caca_sprite;
    167191struct caca_sprite * caca_load_sprite(const char *);
    168192int caca_get_sprite_frames(struct caca_sprite *);
     
    177201 * Bitmap handling
    178202 */
     203struct caca_bitmap;
    179204struct caca_bitmap *caca_create_bitmap(int, int, int, int, int, int, int);
    180205void caca_draw_bitmap(int, int, int, int, struct caca_bitmap *, char *);
  • libcaca/trunk/src/caca_internals.h

    r193 r205  
    33 *   Copyright (c) 2002, 2003 Sam Hocevar <sam@zoy.org>
    44 *                 All Rights Reserved
    5  *
    6  *   $Id$
    75 *
    86 *   This library is free software; you can redistribute it and/or
     
    2220 */
    2321
     22/**  \file caca_internals.h
     23 *   \version \$Id$
     24 *   \author Sam Hocevar <sam@zoy.org>
     25 *   \brief The \e libcaca private header.
     26 *
     27 *   This header contains the private types and functions used by \e libcaca.
     28 */
     29
    2430#ifndef __CACA_INTERNALS_H__
    2531#define __CACA_INTERNALS_H__
  • libcaca/trunk/src/conic.c

    r192 r205  
    44 *                 All Rights Reserved
    55 *
    6  *   $Id$
    7  *
    86 *   This library is free software; you can redistribute it and/or
    97 *   modify it under the terms of the GNU Lesser General Public
     
    2018 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
    2119 *   02111-1307  USA
     20 */
     21
     22/**  \file conic.c
     23 *   \version \$Id$
     24 *   \author Sam Hocevar <sam@zoy.org>
     25 *   \brief Ellipse and circle drawing functions
     26 *
     27 *   This file contains ellipse and circle drawing functions, both filled
     28 *   and outline.
    2229 */
    2330
  • libcaca/trunk/src/graphics.c

    r193 r205  
    33 *   Copyright (c) 2002, 2003 Sam Hocevar <sam@zoy.org>
    44 *                 All Rights Reserved
    5  *
    6  *   $Id$
    75 *
    86 *   This library is free software; you can redistribute it and/or
     
    2018 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
    2119 *   02111-1307  USA
     20 */
     21
     22/**  \file graphics.c
     23 *   \version \$Id$
     24 *   \author Sam Hocevar <sam@zoy.org>
     25 *   \brief Character drawing functions
     26 *
     27 *   This file contains character and string drawing functions.
    2228 */
    2329
  • libcaca/trunk/src/io.c

    r203 r205  
    33 *   Copyright (c) 2002, 2003 Sam Hocevar <sam@zoy.org>
    44 *                 All Rights Reserved
    5  *
    6  *   $Id$
    75 *
    86 *   This library is free software; you can redistribute it and/or
     
    2018 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
    2119 *   02111-1307  USA
     20 */
     21
     22/**  \file io.c
     23 *   \version \$Id$
     24 *   \author Sam Hocevar <sam@zoy.org>
     25 *   \brief Event handling functions
     26 *
     27 *   This file contains event handling functions for keyboard and mouse input.
    2228 */
    2329
  • libcaca/trunk/src/line.c

    r192 r205  
    44 *                 All Rights Reserved
    55 *
    6  *   $Id$
    7  *
    86 *   This library is free software; you can redistribute it and/or
    97 *   modify it under the terms of the GNU Lesser General Public
     
    2018 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
    2119 *   02111-1307  USA
     20 */
     21
     22/**  \file line.c
     23 *   \version \$Id$
     24 *   \author Sam Hocevar <sam@zoy.org>
     25 *   \brief Line drawing functions
     26 *
     27 *   This file contains line and polyline drawing functions, with both thin
     28 *   and thick styles.
    2229 */
    2330
     
    5663 * \param y2 Y coordinate of the second point.
    5764 * \param c Character to draw the line with.
    58  * \return nothing
     65 * \return void
    5966 */
    6067void caca_draw_line(int x1, int y1, int x2, int y2, char c)
     
    94101 * \param x2 X coordinate of the second point.
    95102 * \param y2 Y coordinate of the second point.
    96  * \return nothing
     103 * \return void
    97104 */
    98105void caca_draw_thin_line(int x1, int y1, int x2, int y2)
     
    131138 *
    132139 * \param s a line structure
    133  * \return nothing
     140 * \return void
    134141 */
    135142static void clip_line(struct line* s)
     
    213220 *
    214221 * \param s a line structure
    215  * \return nothing
     222 * \return void
    216223 */
    217224static void draw_solid_line(struct line* s)
     
    280287 *
    281288 * \param s a line structure
    282  * \return nothing
     289 * \return void
    283290 */
    284291static void draw_thin_line(struct line* s)
  • libcaca/trunk/src/math.c

    r192 r205  
    33 *   Copyright (c) 2002, 2003 Sam Hocevar <sam@zoy.org>
    44 *                 All Rights Reserved
    5  *
    6  *   $Id$
    75 *
    86 *   This library is free software; you can redistribute it and/or
     
    2018 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
    2119 *   02111-1307  USA
     20 */
     21
     22/**  \file math.c
     23 *   \version \$Id$
     24 *   \author Sam Hocevar <sam@zoy.org>
     25 *   \brief Math functions
     26 *
     27 *   This file contains simple mathematical routines.
    2228 */
    2329
  • libcaca/trunk/src/sprite.c

    r192 r205  
    44 *                 All Rights Reserved
    55 *
    6  *   $Id$
    7  *
    86 *   This library is free software; you can redistribute it and/or
    97 *   modify it under the terms of the GNU Lesser General Public
     
    2018 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
    2119 *   02111-1307  USA
     20 */
     21
     22/**  \file sprite.c
     23 *   \version \$Id$
     24 *   \author Sam Hocevar <sam@zoy.org>
     25 *   \brief Sprite loading and blitting
     26 *
     27 *   This file contains a small framework for sprite loading and blitting.
    2228 */
    2329
  • libcaca/trunk/src/triangle.c

    r192 r205  
    33 *   Copyright (c) 2002, 2003 Sam Hocevar <sam@zoy.org>
    44 *                 All Rights Reserved
    5  *
    6  *   $Id$
    75 *
    86 *   This library is free software; you can redistribute it and/or
     
    2018 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
    2119 *   02111-1307  USA
     20 */
     21
     22/**  \file triangle.c
     23 *   \version \$Id$
     24 *   \author Sam Hocevar <sam@zoy.org>
     25 *   \brief Triangle drawing functions
     26 *
     27 *   This file contains triangle drawing functions, both filled and outline.
    2228 */
    2329
Note: See TracChangeset for help on using the changeset viewer.