From 61776befc3f88c373e47ccbdf8c75e2ca0f4e987 Mon Sep 17 00:00:00 2001
From: Campbell Barton <ideasman42@gmail.com>
Date: Thu, 9 Dec 2021 00:55:11 +1100
Subject: Cleanup: move public doc-strings into headers for 'editors'

Ref T92709
---
 source/blender/editors/space_file/filesel.c | 43 -----------------------------
 1 file changed, 43 deletions(-)

(limited to 'source/blender/editors/space_file/filesel.c')

diff --git a/source/blender/editors/space_file/filesel.c b/source/blender/editors/space_file/filesel.c
index 8d89fbbd80f..e3ac5840da3 100644
--- a/source/blender/editors/space_file/filesel.c
+++ b/source/blender/editors/space_file/filesel.c
@@ -358,9 +358,6 @@ static FileSelectParams *fileselect_ensure_updated_file_params(SpaceFile *sfile)
   return params;
 }
 
-/**
- * If needed, create and return the file select parameters for the active browse mode.
- */
 FileSelectParams *ED_fileselect_ensure_active_params(SpaceFile *sfile)
 {
   switch ((eFileBrowse_Mode)sfile->browse_mode) {
@@ -380,9 +377,6 @@ FileSelectParams *ED_fileselect_ensure_active_params(SpaceFile *sfile)
   return NULL;
 }
 
-/**
- * Get the file select parameters for the active browse mode.
- */
 FileSelectParams *ED_fileselect_get_active_params(const SpaceFile *sfile)
 {
   if (!sfile) {
@@ -647,13 +641,6 @@ void ED_fileselect_set_params_from_userdef(SpaceFile *sfile)
   }
 }
 
-/**
- * Update the user-preference data for the file space. In fact, this also contains some
- * non-FileSelectParams data, but we can safely ignore this.
- *
- * \param temp_win_size: If the browser was opened in a temporary window,
- * pass its size here so we can store that in the preferences. Otherwise NULL.
- */
 void ED_fileselect_params_to_userdef(SpaceFile *sfile,
                                      const int temp_win_size[2],
                                      const bool is_maximized)
@@ -691,9 +678,6 @@ void ED_fileselect_params_to_userdef(SpaceFile *sfile,
   }
 }
 
-/**
- * Sets FileSelectParams->file (name of selected file)
- */
 void fileselect_file_set(SpaceFile *sfile, const int index)
 {
   const struct FileDirEntry *file = filelist_file(sfile->files, index);
@@ -814,10 +798,6 @@ int ED_fileselect_layout_offset(FileLayout *layout, int x, int y)
   return active_file;
 }
 
-/**
- * Get the currently visible bounds of the layout in screen space. Matches View2D.mask minus the
- * top column-header row.
- */
 void ED_fileselect_layout_maskrect(const FileLayout *layout, const View2D *v2d, rcti *r_rect)
 {
   *r_rect = v2d->mask;
@@ -857,9 +837,6 @@ void ED_fileselect_layout_tilepos(FileLayout *layout, int tile, int *x, int *y)
   }
 }
 
-/**
- * Check if the region coordinate defined by \a x and \a y are inside the column header.
- */
 bool file_attribute_column_header_is_inside(const View2D *v2d,
                                             const FileLayout *layout,
                                             int x,
@@ -886,9 +863,6 @@ bool file_attribute_column_type_enabled(const FileSelectParams *params,
   }
 }
 
-/**
- * Find the column type at region coordinate given by \a x (y doesn't matter for this).
- */
 FileAttributeColumnType file_attribute_column_type_find_isect(const View2D *v2d,
                                                               const FileSelectParams *params,
                                                               FileLayout *layout,
@@ -1105,10 +1079,6 @@ FileLayout *ED_fileselect_get_layout(struct SpaceFile *sfile, ARegion *region)
   return sfile->layout;
 }
 
-/**
- * Support updating the directory even when this isn't the active space
- * needed so RNA properties update function isn't context sensitive, see T70255.
- */
 void ED_file_change_dir_ex(bContext *C, ScrArea *area)
 {
   /* May happen when manipulating non-active spaces. */
@@ -1304,12 +1274,6 @@ void file_params_smoothscroll_timer_clear(wmWindowManager *wm, wmWindow *win, Sp
   sfile->smoothscroll_timer = NULL;
 }
 
-/**
- * Set the renaming-state to #FILE_PARAMS_RENAME_POSTSCROLL_PENDING and trigger the smooth-scroll
- * timer. To be used right after a file was renamed.
- * Note that the caller is responsible for setting the correct rename-file info
- * (#FileSelectParams.renamefile or #FileSelectParams.rename_id).
- */
 void file_params_invoke_rename_postscroll(wmWindowManager *wm, wmWindow *win, SpaceFile *sfile)
 {
   FileSelectParams *params = ED_fileselect_get_active_params(sfile);
@@ -1323,9 +1287,6 @@ void file_params_invoke_rename_postscroll(wmWindowManager *wm, wmWindow *win, Sp
   sfile->scroll_offset = 0;
 }
 
-/**
- * To be executed whenever renaming ends (successfully or not).
- */
 void file_params_rename_end(wmWindowManager *wm,
                             wmWindow *win,
                             SpaceFile *sfile,
@@ -1357,10 +1318,6 @@ static int file_params_find_renamed(const FileSelectParams *params, struct FileL
                                        filelist_file_find_path(filelist, params->renamefile);
 }
 
-/**
- * Helper used by both main update code, and smooth-scroll timer,
- * to try to enable rename editing from #FileSelectParams.renamefile name.
- */
 void file_params_renamefile_activate(SpaceFile *sfile, FileSelectParams *params)
 {
   BLI_assert(params->rename_flag != 0);
-- 
cgit v1.2.3