Rolled back comments. According to new guidelines, no .c files

should contain doxygen comments.
This commit is contained in:
Casey Corn
2003-06-18 03:48:55 +00:00
parent 63537d1e77
commit 17ca22de62
7 changed files with 26 additions and 586 deletions

View File

@@ -29,33 +29,13 @@
*
* ***** END GPL/BL DUAL LICENSE BLOCK *****
*/
/**
* \file B.blend.c
* \brief DataToC output of file <B_blend>
*
* Contains the data to create the default initial .blend file that
* is loaded. It contains the default user preferences and initial
* blend screen with the plane and the camera.
*
* Referenced in usiblender.c
* \ingroup defaultconfig
*/
/* DataToC output of file <B_blend> */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
/**
* Array size.
* This is generated automatically, and should not be changed.
*/
int datatoc_B_blend_size= 32472;
/**
* The is an array of characters which creates the .blend file.
* This is generated automatically, and should not be changed.
*/
char datatoc_B_blend[]= {
66, 76, 69, 78, 68, 69, 82, 95,118, 50, 49, 50, 82, 69, 78, 68, 32, 0, 0, 0,136,237,255,191,
0, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0,250, 0, 0, 0, 49, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,

View File

@@ -29,27 +29,9 @@
*
* ***** END GPL/BL DUAL LICENSE BLOCK *****
*/
/**
* \file blenderbuttons.c
* \brief DataToC output of file <blenderbuttons_png>
*
* Contains an array of image data used to create the buttons used in the
* blender gui.
*
* Referenced in resources.c
* \ingroup defaultconfig
*/
/* DataToC output of file <blenderbuttons_png> */
/**
* Array size.
* This is generated automatically, and should not be changed.
*/
int datatoc_blenderbuttons_size= 42002;
/**
* The is an array of characters which creates the icon file.
* This is generated automatically, and should not be changed.
*/
char datatoc_blenderbuttons[]= {
137, 80, 78, 71, 13, 10, 26, 10, 0, 0, 0, 13, 73, 72, 68, 82, 0, 0,
1,190, 0, 0, 0,242, 8, 2, 0, 0, 0,189, 2, 55, 29, 0, 0, 0, 9,112, 72, 89,115, 0, 0, 11, 19, 0, 0, 11, 19, 1,

View File

@@ -28,24 +28,9 @@
* Contributor(s): none yet.
*
* ***** END GPL/BL DUAL LICENSE BLOCK *****
*/
/**
* \file mainqueue.c
* \brief Just the functions to maintain a central event queue.
*
* Creates the functionality of a FIFO queue for events.
*
* \note The documentor (me) doesn't know the full description of
* the fields of the QEvent structure, and the parameters to the
* functions (event, val, ascii). The comments should be updated
* with more detailed descriptions of what is stored in each one.
*
* \warning This queue structure uses a method that assumes the presence
* of allocated memory. As well it doesn't de-allocate memory after
* a read off of the queue, thereby causing a situation whereby memory
* isn't being freed and can grow with out bound even though there is
* a limit on the queue size.
* Just the functions to maintain a central event
* queue.
*/
#include <stdlib.h>
@@ -56,49 +41,15 @@
#include <config.h>
#endif
/**
* \struct QEvent
* \brief This is the definition for the event queue datastructure
*/
typedef struct {
/**
* \var unsigned short event
* \brief holds the event type
*/
unsigned short event;
/**
* \var short val
*/
short val;
/**
* \var char ascii
*/
char ascii;
} QEvent;
/**
* \var static QEvent mainqueue[MAXQUEUE]
* \brief The Main Queue store.
*/
static QEvent mainqueue[MAXQUEUE];
/**
* \var static unsigned int nevents=0
* \brief The count of the events currently stored.
*/
static unsigned int nevents= 0;
/**
* \brief Reads and removes events from the queue and returns the event type,
* if the queue is empty return 0.
* \param val the val of the event to read into.
* \param ascii the buffer of the event to read into.
* \return the event type or 0 if no event.
*
* Pops off the last item in the queue and returns the pieces in their
* little parts. The last item was the oldest item in the queue.
*
*/
unsigned short mainqread(short *val, char *ascii)
{
if (nevents) {
@@ -111,24 +62,11 @@ unsigned short mainqread(short *val, char *ascii)
return 0;
}
/**
* \brief A short cut to mainqenter_ext setting ascii to 0
*/
void mainqenter(unsigned short event, short val)
{
mainqenter_ext(event, val, 0);
}
/**
* \brief Adds event to the beginning of the queue.
* \param event the event type.
* \param val the val of the event.
* \param ascii the event characters.
*
* If the event isn't nothing, and if the queue still
* has some room, then add to the queue. Otherwise the
* event is lost.
*/
void mainqenter_ext(unsigned short event, short val, char ascii)
{
if (!event)
@@ -144,19 +82,6 @@ void mainqenter_ext(unsigned short event, short val, char ascii)
}
}
/**
* \brief Pushes and event back on to the front of the queue.
* \param event
* \param val
* \param ascii
*
* Pushes an event back onto the queue, possibly after a peek
* at the item. This method assumes that the memory has already
* been allocated and should be mentioned in a precondition.
*
* \pre This method assumes that the memory is already allocated
* for the event.
*/
void mainqpushback(unsigned short event, short val, char ascii)
{
if (nevents<MAXQUEUE) {
@@ -167,12 +92,6 @@ void mainqpushback(unsigned short event, short val, char ascii)
}
}
/**
* \brief Returns the event type from the last item in the queue
* (the next one that would be popped off). Probably used as a test
* to see if the queue is empty or if a valid event is still around.
* \return the event type of the last item in the queue
*/
unsigned short mainqtest()
{
if (nevents)