awesomewm-mirrors
/
awesome
mirror of https://github.com/awesomeWM/awesome.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Documentation generation fixes. 

- Fix many instances of incorrect and incomplete doxygen annotations.
- Teach doxygen not to complain when it comes accross gcc __attribute__
specifications.
- Turn off graph generation by default.
- Make doxygen quiet, so we can actually see warnings when they occur.
This commit is contained in:
Aldo Cortesi 2007-12-19 14:26:20 +11:00 committed by Julien Danjou
parent 4664fba970
commit cbf5c474c1
8 changed files with 58 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
awesome.c
View File

@ -234,16 +234,18 @@ setup_screen(int screen)
/** Startup Error handler to check if another window manager
* is already running.
* \param disp Display ref
* \param disp Display
* \param ee Error event
*/
static int __attribute__ ((noreturn))
xerrorstart(Display * disp __attribute__ ((unused)), XErrorEvent * ee __attribute__ ((unused)))
xerrorstart(Display * disp __attribute__ ((unused)),
XErrorEvent * ee __attribute__ ((unused)))
{
eprint("another window manager is already running\n");
}
/** Quit awesome
* \param screen Screen ID
* \param arg nothing
* \ingroup ui_callback
*/

53
awesome.doxygen
View File

@ -29,7 +29,7 @@ MULTILINE_CPP_IS_BRIEF = NO
DETAILS_AT_TOP = NO
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 8
TAB_SIZE = 4
ALIASES =
OPTIMIZE_OUTPUT_FOR_C = YES
OPTIMIZE_OUTPUT_JAVA = NO
@ -70,7 +70,7 @@ FILE_VERSION_FILTER =
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET = NO
QUIET = YES
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
@ -83,50 +83,11 @@ WARN_LOGFILE =
INPUT = .
INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.c \
*.cc \
*.cxx \
*.cpp \
*.c++ \
*.d \
*.java \
*.ii \
*.ixx \
*.ipp \
*.i++ \
*.inl \
*.h \
*.hh \
*.hxx \
*.hpp \
*.h++ \
*.idl \
*.odl \
*.cs \
*.php \
*.php3 \
*.inc \
*.m \
*.mm \
*.dox \
*.py \
*.C \
*.CC \
*.C++ \
*.II \
*.I++ \
*.H \
*.HH \
*.H++ \
*.CS \
*.PHP \
*.PHP3 \
*.M \
*.MM \
*.PY
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS =
EXAMPLE_PATH =
EXAMPLE_PATTERNS = *
@ -227,12 +188,12 @@ PERLMOD_MAKEVAR_PREFIX =
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = NO
EXPAND_ONLY_PREDEF = NO
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED =
PREDEFINED = "__attribute__(x)="
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
@ -249,7 +210,7 @@ PERL_PATH = /usr/bin/perl
CLASS_DIAGRAMS = NO
MSCGEN_PATH =
HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = YES
HAVE_DOT = NO
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
GROUP_GRAPHS = YES

29
client.c
View File

@ -42,7 +42,7 @@ extern awesome_config globalconf;
* and floating state before awesome was restarted if any
* \todo this may bug if number of tags is != than before
* \param c Client ref
* \param ntags tags number
* \param screen Screen ID
*/
static Bool
client_loadprops(Client * c, int screen)
@ -79,7 +79,7 @@ client_loadprops(Client * c, int screen)
/** Check if client supports protocol WM_DELETE_WINDOW
* \param disp the display
* \win the Window
* \param win the Window
* \return True if client has WM_DELETE_WINDOW
*/
static Bool
@ -194,6 +194,7 @@ client_detach(Client *c)
/** Give focus to client, or to first client if c is NULL
* \param c client
* \param selscreen True if current screen is selected
* \param screen Screen ID
*/
void
focus(Client *c, Bool selscreen, int screen)
@ -247,6 +248,7 @@ focus(Client *c, Bool selscreen, int screen)
/** Manage a new client
* \param w The window
* \param wa Window attributes
* \param screen Screen ID
*/
void
client_manage(Window w, XWindowAttributes *wa, int screen)
@ -593,6 +595,7 @@ client_isvisible(Client *c, int screen)
}
/** Set selected client transparency
* \param screen Screen ID
* \param arg unused arg
* \ingroup ui_callback
*/
@ -642,6 +645,7 @@ uicb_client_settrans(int screen __attribute__ ((unused)), char *arg)
/** Set border size
* \param screen Screen ID
* \param arg X, +X or -X
* \ingroup ui_callback
*/
@ -655,6 +659,9 @@ uicb_setborder(int screen, char *arg)
globalconf.screens[screen].borderpx = 0;
}
/** Swap current with next client
* \ingroup ui_callback
*/
void
uicb_client_swapnext(int screen, char *arg __attribute__ ((unused)))
{
@ -673,6 +680,9 @@ uicb_client_swapnext(int screen, char *arg __attribute__ ((unused)))
}
}
/** Swap current with previous client
* \ingroup ui_callback
*/
void
uicb_client_swapprev(int screen, char *arg __attribute__ ((unused)))
{
@ -691,6 +701,11 @@ uicb_client_swapprev(int screen, char *arg __attribute__ ((unused)))
}
}
/** Move and resize client
* \param screen Screen ID
* \param arg x y w h
* \ingroup ui_callback
*/
void
uicb_client_moveresize(int screen, char *arg)
{
@ -716,17 +731,23 @@ uicb_client_moveresize(int screen, char *arg)
ow = sel->w;
oh = sel->h;
Bool xqp = XQueryPointer(globalconf.display, RootWindow(globalconf.display, get_phys_screen(screen)), &dummy, &dummy, &mx, &my, &dx, &dy, &dui);
Bool xqp = XQueryPointer(globalconf.display,
RootWindow(globalconf.display,
get_phys_screen(screen)),
&dummy, &dummy, &mx, &my, &dx, &dy, &dui);
client_resize(sel, nx, ny, nw, nh, True, False);
if (xqp && ox <= mx && (ox + ow) >= mx && oy <= my && (oy + oh) >= my)
{
nmx = mx - ox + sel->w - ow - 1 < 0 ? 0 : mx - ox + sel->w - ow - 1;
nmy = my - oy + sel->h - oh - 1 < 0 ? 0 : my - oy + sel->h - oh - 1;
XWarpPointer(globalconf.display, None, sel->win, 0, 0, 0, 0, nmx, nmy);
XWarpPointer(globalconf.display,
None, sel->win,
0, 0, 0, 0, nmx, nmy);
}
}
/** Kill selected client
* \param screen Screen ID
* \param arg unused
* \ingroup ui_callback
*/

4
config.c
View File

@ -20,7 +20,7 @@
*/
/**
* \defgroup ui_callback
* @defgroup ui_callback User Interface Callbacks
*/
#include <confuse.h>
@ -301,7 +301,7 @@ create_widgets(cfg_t* cfg_statusbar, Statusbar *statusbar)
}
/** Parse configuration file and initialize some stuff
* \param configpatharg Path to configuration file
* \param confpatharg Path to configuration file
*/
void
config_parse(const char *confpatharg)

5
screen.c
View File

@ -32,6 +32,7 @@ extern awesome_config globalconf;
* \param screen Screen number
* \param statusbar statusbar
* \return ScreenInfo struct array with all screens info
* \param padding Padding
*/
ScreenInfo *
get_screen_info(int screen, Statusbar *statusbar, Padding *padding)
@ -83,6 +84,7 @@ get_screen_info(int screen, Statusbar *statusbar, Padding *padding)
/** Get display info
* \param screen Screen number
* \param statusbar the statusbar
* \param padding Padding
* \return ScreenInfo struct pointer with all display info
*/
ScreenInfo *
@ -170,6 +172,7 @@ get_phys_screen(int screen)
/** Move a client to a virtual screen
* \param c the client
* \param new_screen The destinatiuon screen
* \param doresize set to True if we also move the client to the new x_org and
* y_org of the new screen
*/
@ -238,6 +241,7 @@ move_mouse_pointer_to_screen(int screen)
/** Switch focus to a specified screen
* \param screen Screen ID
* \param arg screen number
* \ingroup ui_callback
*/
@ -263,6 +267,7 @@ uicb_screen_focus(int screen, char *arg)
}
/** Move client to a virtual screen (if Xinerama is active)
* \param screen Screen ID
* \param arg screen number
* \ingroup ui_callback
*/

8
tag.c
View File

@ -135,6 +135,7 @@ tag_client_with_rules(Client *c)
}
/** Tag selected window with tag
* \param screen Screen ID
* \param arg Tag name
* \ingroup ui_callback
*/
@ -172,6 +173,7 @@ uicb_client_tag(int screen, char *arg)
}
/** Toggle floating state of a client
* \param screen Screen ID
* \param arg unused
* \ingroup ui_callback
*/
@ -195,6 +197,7 @@ uicb_client_togglefloating(int screen, char *arg __attribute__ ((unused)))
}
/** Toggle a tag on client
* \param screen Screen ID
* \param arg Tag name
* \ingroup ui_callback
*/
@ -240,6 +243,7 @@ uicb_client_toggletag(int screen, char *arg)
}
/** Add a tag to viewed tags
* \param screen Screen ID
* \param arg Tag name
* \ingroup ui_callback
*/
@ -272,6 +276,7 @@ uicb_tag_toggleview(int screen, char *arg)
}
/** View tag
* \param screen Screen ID
* \param arg tag to view
* \ingroup ui_callback
*/
@ -302,6 +307,7 @@ uicb_tag_view(int screen, char *arg)
}
/** View previously selected tags
* \param screen Screen ID
* \param arg unused
* \ingroup ui_callback
*/
@ -321,6 +327,7 @@ uicb_tag_prev_selected(int screen, char *arg __attribute__ ((unused)))
}
/** View next tag
* \param screen Screen ID
* \param arg unused
* \ingroup ui_callback
*/
@ -340,6 +347,7 @@ uicb_tag_viewnext(int screen, char *arg __attribute__ ((unused)))
}
/** View previous tag
* \param screen Screen ID
* \param arg unused
* \ingroup ui_callback
*/

8
window.c
View File

@ -89,12 +89,16 @@ window_configure(Display *disp, Window win, int x, int y, int w, int h, int bord
/** Grab or ungrab buttons on a window
* \param disp Display ref
* \param screen The screen
* \param win The window
* \param focused True if client is focused
* \param raised True if the client is above other clients
* \param modkey Mod key mask
*/
void
window_grabbuttons(Display *disp, int screen, Window win, Bool focused, Bool raised)
window_grabbuttons(Display *disp,
int screen,
Window win,
Bool focused,
Bool raised)
{
Button *b;

2
xutil.c
View File

@ -115,7 +115,7 @@ xgettextprop(Display *disp, Window w, Atom atom, char *text, ssize_t textlen)
/** Initialize an X color
* \param screen Screen number
* \param colorstr Color specification
* \param colstr Color specification
*/
XColor
initxcolor(int screen, const char *colstr)