Rename tree_close() to tree_close_internal().

It should be clear for callers of this function that this is an internal
function that skips certain validations which might be important. Therefore
we make it clear that this is an internal function by renaming it.

relates to #1761
This commit is contained in:
Ingo Bürk
2015-12-27 20:58:35 -05:00
parent dc463077d6
commit 0dd71674de
10 changed files with 28 additions and 28 deletions

View File

@ -278,7 +278,7 @@ orientation_t con_orientation(Con *con);
/**
* Returns the container which will be focused next when the given container
* is not available anymore. Called in tree_close and con_move_to_workspace
* is not available anymore. Called in tree_close_internal and con_move_to_workspace
* to properly restore focus.
*
*/

View File

@ -62,7 +62,7 @@ typedef enum { BS_NORMAL = 0,
BS_NONE = 1,
BS_PIXEL = 2 } border_style_t;
/** parameter to specify whether tree_close() and x_window_kill() should kill
/** parameter to specify whether tree_close_internal() and x_window_kill() should kill
* only this specific window or the whole X11 client */
typedef enum { DONT_KILL_WINDOW = 0,
KILL_WINDOW = 1,

View File

@ -57,7 +57,7 @@ bool level_down(void);
void tree_render(void);
/**
* Closes the current container using tree_close().
* Closes the current container using tree_close_internal().
*
*/
void tree_close_con(kill_window_t kill_window);
@ -78,11 +78,11 @@ void tree_next(char way, orientation_t orientation);
* recursively while deleting a containers children.
*
* The force_set_focus flag is specified in the case of killing a floating
* window: tree_close() will be invoked for the CT_FLOATINGCON (the parent
* window: tree_close_internal() will be invoked for the CT_FLOATINGCON (the parent
* container) and focus should be set there.
*
*/
bool tree_close(Con *con, kill_window_t kill_window, bool dont_kill_parent, bool force_set_focus);
bool tree_close_internal(Con *con, kill_window_t kill_window, bool dont_kill_parent, bool force_set_focus);
/**
* Loads tree from ~/.i3/_restart.json (used for in-place restarts).