openttd-mini: comparison src/window.cpp

equal deleted inserted replaced

-:1bab3df59b91
+:63fbe9f76801
 	if (w == NULL) return;
 	SetDirtyBlocks(w->left, w->top, w->left + w->width, w->top + w->height);
 }
 /** Find the Window whose parent pointer points to this window
-* @parent w Window to find child of
+* @param w parent Window to find child of
-* @return return a Window pointer that is the child of w, or NULL otherwise */
+* @return a Window pointer that is the child of w, or NULL otherwise */
 static Window *FindChildWindow(const Window *w)
 {
 	Window* const *wz;
 	FOR_ALL_WINDOWS(wz) {
 	return NULL;
 }
 /** Find the z-value of a window. A window must already be open
-* or the behaviour is undefined but function should never fail */
+* or the behaviour is undefined but function should never fail
+* @param w window to query Z Position
+* @return the window that matches it */
 Window **FindWindowZPosition(const Window *w)
 {
 	Window **wz;
 	for (wz = _z_windows; wz != _last_z_window; wz++) {
 }
 static void BringWindowToFront(const Window *w);
 /** Find a window and make it the top-window on the screen. The window
-* gets a white border for a brief period of time to visualize its
+* gets a white border for a brief period of time to visualize its "activation"
-* "activation"
+* @param cls WindowClass of the window to activate
+* @param number WindowNumber of the window to activate
 * @return a pointer to the window thus activated */
 Window *BringWindowToFrontById(WindowClass cls, WindowNumber number)
 {
 	Window *w = FindWindowById(cls, number);
 bool IsWindowOfPrototype(const Window *w, const Widget *widget)
 {
 	return (w->original_widget == widget);
 }
-/* Copies 'widget' to 'w->widget' to allow for resizable windows */
+/** Copies 'widget' to 'w->widget' to allow for resizable windows
+* @param w Window on which to attach the widget array
+* @param widget pointer of widget array to fill the window with */
 void AssignWidgetToWindow(Window *w, const Widget *widget)
 {
 	w->original_widget = widget;
 	if (widget != NULL) {
 	assert(_last_z_window == endof(_z_windows));
 	return NULL;
 }
-/* Open a new window.
+/** Open a new window.
 * This function is called from AllocateWindow() or AllocateWindowDesc()
 * See descriptions for those functions for usage
 * See AllocateWindow() for description of arguments.
 * Only addition here is window_number, which is the window_number being assigned to the new window
-*/
+* @param x offset in pixels from the left of the screen
+* @param y offset in pixels from the top of the screen
+* @param width width in pixels of the window
+* @param height height in pixels of the window
+* @param *proc see WindowProc function to call when any messages/updates happen to the window
+* @param cls see WindowClass class of the window, used for identification and grouping
+* @param *widget see Widget pointer to the window layout and various elements
+* @param window_number number being assigned to the new window
+* @return Window pointer of the newly created window */
 static Window *LocalAllocateWindow(
 							int x, int y, int width, int height,
 							WindowProc *proc, WindowClass cls, const Widget *widget, int window_number)
 {
 	Window *w = FindFreeWindow();
 * ones. Finally set all variables and call the WE_CREATE event
 * @param x offset in pixels from the left of the screen
 * @param y offset in pixels from the top of the screen
 * @param width width in pixels of the window
 * @param height height in pixels of the window
-* @param *proc @see WindowProc function to call when any messages/updates happen to the window
+* @param *proc see WindowProc function to call when any messages/updates happen to the window
-* @param cls @see WindowClass class of the window, used for identification and grouping
+* @param cls see WindowClass class of the window, used for identification and grouping
-* @param *widget @see Widget pointer to the window layout and various elements
+* @param *widget see Widget pointer to the window layout and various elements
-* @return @see Window pointer of the newly created window
+* @return Window pointer of the newly created window */
-*/
 Window *AllocateWindow(
 							int x, int y, int width, int height,
 							WindowProc *proc, WindowClass cls, const Widget *widget)
 {
 	return LocalAllocateWindow(x, y, width, height, proc, cls, widget, 0);
 }
 /**
 * Open a new window.
 * @param *desc The pointer to the WindowDesc to be created
-* @return @see Window pointer of the newly created window
+* @return Window pointer of the newly created window
 */
 Window *AllocateWindowDesc(const WindowDesc *desc)
 {
 	return LocalAllocateWindowDesc(desc, 0);
 }
 /**
 * Open a new window.
 * @param *desc The pointer to the WindowDesc to be created
 * @param window_number the window number of the new window
-* @return @see Window pointer of the newly created window
+* @return see Window pointer of the newly created window
 */
 Window *AllocateWindowDescFront(const WindowDesc *desc, int window_number)
 {
 	Window *w;
 	return w;
 }
 /** Do a search for a window at specific coordinates. For this we start
 * at the topmost window, obviously and work our way down to the bottom
+* @param x position x to query
+* @param y position y to query
 * @return a pointer to the found window if any, NULL otherwise */
 Window *FindWindowFromPt(int x, int y)
 {
 	Window* const *wz;
 	if (bring_to_front) BringWindowToFront(w);
 	return true;
 }
 /** Send a message from one window to another. The receiving window is found by
-* @param w see Window pointer pointing to the other window
+* @param w Window pointer pointing to the other window
 * @param msg Specifies the message to be sent
 * @param wparam Specifies additional message-specific information
 * @param lparam Specifies additional message-specific information
 */
 static void SendWindowMessageW(Window *w, uint msg, uint wparam, uint lparam)
 			goto restart_search;
 		}
 	}
 }
-/* It is possible that a stickied window gets to a position where the
+/** It is possible that a stickied window gets to a position where the
 * 'close' button is outside the gaming area. You cannot close it then; except
 * with this function. It closes all windows calling the standard function,
 * then, does a little hacked loop of closing all stickied windows. Note
 * that standard windows (status bar, etc.) are not stickied, so these aren't affected */
 void DeleteAllNonVitalWindows()
 			goto restart_search;
 		}
 	}
 }
-/* Delete all always on-top windows to get an empty screen */
+/** Delete all always on-top windows to get an empty screen */
 void HideVitalWindows()
 {
 	DeleteWindowById(WC_TOOLBAR_MENU, 0);
 	DeleteWindowById(WC_MAIN_TOOLBAR, 0);
 	DeleteWindowById(WC_STATUS_BAR, 0);

changeset 6443	63fbe9f76801
parent 6432	226650eb2ef3
child 6481	85ad87daf4b0