Cleanup: move file descriptions into doxygen file section

Continuation of 19100aa57d.
2022-02-09 18:31:42 +11:00 · 2022-02-09 18:31:42 +11:00 · 81da638c44
parent 19100aa57d
commit 81da638c44
52 changed files with 33 additions and 62 deletions
--- a/intern/ghost/intern/GHOST_DisplayManagerX11.cpp
+++ b/intern/ghost/intern/GHOST_DisplayManagerX11.cpp
@ -13,11 +13,9 @@
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
- * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
- * All rights reserved.
- * Video mode switching
- * Copyright (C) 1997-2001 Id Software, Inc.
- * Ported from Quake 2 by Alex Fraser <alex@phatcore.com>
+ * Copyright 2001-2002 NaN Holding BV. All rights reserved.
+ *           1997-2001 Id Software, Inc. Video mode switching.
+                       Ported from Quake 2 by Alex Fraser <alex@phatcore.com>.
 */

 /** \file
--- a/intern/ghost/intern/GHOST_SystemX11.cpp
+++ b/intern/ghost/intern/GHOST_SystemX11.cpp
@ -13,10 +13,9 @@
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
- * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
- * All rights reserved.
- * Part of this code has been taken from Qt, under LGPL license
- * Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+ * Copyright 2001-2002 NaN Holding BV. All rights reserved.
+ *           2009 Nokia Corporation and/or its subsidiary(-ies).
+                  Part of this code has been taken from Qt, under LGPL license.
 */

 /** \file
--- a/intern/iksolver/extern/IK_solver.h
+++ b/intern/iksolver/extern/IK_solver.h
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * Original author: Laurence
 */

 /** \file
--- a/intern/iksolver/intern/IK_Math.h
+++ b/intern/iksolver/intern/IK_Math.h
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * Original author: Laurence
 */

 /** \file
--- a/intern/iksolver/intern/IK_QSegment.h
+++ b/intern/iksolver/intern/IK_QSegment.h
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * Original author: Laurence
 */

 /** \file
--- a/intern/iksolver/intern/IK_QTask.h
+++ b/intern/iksolver/intern/IK_QTask.h
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * Original author: Laurence
 */

 /** \file
--- a/source/blender/blenkernel/intern/cdderivedmesh.c
+++ b/source/blender/blenkernel/intern/cdderivedmesh.c
@ -15,11 +15,11 @@
 *
 * The Original Code is Copyright (C) 2006 Blender Foundation.
 * All rights reserved.
- * Implementation of CDDerivedMesh.
 */

 /** \file
 * \ingroup bke
+ * Implementation of #CDDerivedMesh.
 * BKE_cdderivedmesh.h contains the function prototypes for this file.
 */

--- a/source/blender/blenkernel/intern/writeavi.c
+++ b/source/blender/blenkernel/intern/writeavi.c
@ -15,11 +15,11 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * Functions for writing avi-format files.
- * Added interface for generic movie support (ton)
 */

 /** \file
+ * Functions for writing avi-format files.
+ * Added interface for generic movie support (ton)
 * \ingroup bke
 */

--- a/source/blender/blenlib/intern/BLI_dynstr.c
+++ b/source/blender/blenlib/intern/BLI_dynstr.c
@ -15,11 +15,11 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * Dynamically sized string ADT
 */

 /** \file
 * \ingroup bli
+ * Dynamically sized string ADT.
 */

 #include <stdio.h>
--- a/source/blender/blenlib/intern/BLI_linklist.c
+++ b/source/blender/blenlib/intern/BLI_linklist.c
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * Support for linked lists.
 */

 /** \file
--- a/source/blender/blenlib/intern/path_util.c
+++ b/source/blender/blenlib/intern/path_util.c
@ -15,11 +15,11 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * various string, file, list operations.
 */

 /** \file
 * \ingroup bli
+ * Various string, file, list operations.
 */

 #include <ctype.h>
--- a/source/blender/blenlib/intern/winstuff.c
+++ b/source/blender/blenlib/intern/winstuff.c
@ -15,11 +15,11 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * Windows-posix compatibility layer, windows-specific functions.
 */

 /** \file
 * \ingroup bli
+ * Windows-posix compatibility layer, windows-specific functions.
 */

 #ifdef WIN32
--- a/source/blender/blenloader/BLO_undofile.h
+++ b/source/blender/blenloader/BLO_undofile.h
@ -15,13 +15,13 @@
 *
 * The Original Code is Copyright (C) 2004 Blender Foundation.
 * All rights reserved.
- * external writefile function prototypes
 */

 #pragma once

 /** \file
 * \ingroup blenloader
+ * External writefile function prototypes.
 */

 #include "BLI_filereader.h"
@ -91,6 +91,8 @@ void BLO_memfile_chunk_add(MemFileWriteData *mem_data, const char *buf, size_t s
 /**
 * Not memfile itself.
 */
+/* **************** support for memory-write, for undo buffers *************** */
+
 extern void BLO_memfile_free(MemFile *memfile);
 /**
 * Result is that 'first' is being freed.
--- a/source/blender/editors/armature/armature_add.c
+++ b/source/blender/editors/armature/armature_add.c
@ -15,11 +15,11 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * Operators and API's for creating bones
 */

 /** \file
 * \ingroup edarmature
+ * Operators and API's for creating bones.
 */

 #include "DNA_anim_types.h"
--- a/source/blender/editors/armature/armature_edit.c
+++ b/source/blender/editors/armature/armature_edit.c
@ -15,11 +15,11 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * Armature EditMode tools - transforms, chain based editing, and other settings
 */

 /** \file
 * \ingroup edarmature
+ * Armature EditMode tools - transforms, chain based editing, and other settings.
 */

 #include "DNA_armature_types.h"
--- a/source/blender/editors/armature/armature_naming.c
+++ b/source/blender/editors/armature/armature_naming.c
@ -15,11 +15,11 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * Operators and API's for renaming bones both in and out of Edit Mode
 */

 /** \file
 * \ingroup edarmature
+ * Operators and API's for renaming bones both in and out of Edit Mode.
 *
 * This file contains functions/API's for renaming bones and/or working with them.
 */
--- a/source/blender/editors/armature/armature_relations.c
+++ b/source/blender/editors/armature/armature_relations.c
@ -15,11 +15,11 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * Operators for relations between bones and for transferring bones between armature objects
 */

 /** \file
 * \ingroup edarmature
+ * Operators for relations between bones and for transferring bones between armature objects.
 */

 #include "MEM_guardedalloc.h"
--- a/source/blender/editors/armature/armature_select.c
+++ b/source/blender/editors/armature/armature_select.c
@ -15,11 +15,11 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * API's and Operators for selecting armature bones in EditMode
 */

 /** \file
 * \ingroup edarmature
+ * API's and Operators for selecting armature bones in EditMode.
 */

 #include "MEM_guardedalloc.h"
--- a/source/blender/editors/armature/armature_skinning.c
+++ b/source/blender/editors/armature/armature_skinning.c
@ -15,12 +15,12 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * API's for creating vertex groups from bones
- * - Interfaces with heat weighting in meshlaplacian
 */

 /** \file
 * \ingroup edarmature
+ * API's for creating vertex groups from bones
+ * - Interfaces with heat weighting in meshlaplacian.
 */

 #include "DNA_armature_types.h"
--- a/source/blender/editors/include/UI_view2d.h
+++ b/source/blender/editors/include/UI_view2d.h
@ -15,12 +15,12 @@
 *
 * The Original Code is Copyright (C) 2008 Blender Foundation.
 * All rights reserved.
- * Generic 2d view with should allow drawing grids,
- * panning, zooming, scrolling, ..
 */

 /** \file
 * \ingroup editorui
+ * Generic 2D view with should allow drawing grids,
+ * panning, zooming, scrolling, .. etc.
 */

 #pragma once
--- a/source/blender/editors/screen/screendump.c
+++ b/source/blender/editors/screen/screendump.c
@ -15,11 +15,11 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * Making screendumps.
 */

 /** \file
 * \ingroup edscr
+ * Making screenshots of the entire window or sub-regions.
 */

 #include <errno.h>
--- a/source/blender/editors/sculpt_paint/paint_hide.c
+++ b/source/blender/editors/sculpt_paint/paint_hide.c
@ -15,11 +15,11 @@
 *
 * The Original Code is Copyright (C) 2010 by Nicholas Bishop
 * All rights reserved.
- * Implements the PBVH node hiding operator
 */

 /** \file
 * \ingroup edsculpt
+ * Implements the PBVH node hiding operator.
 */

 #include "MEM_guardedalloc.h"
--- a/source/blender/editors/sculpt_paint/sculpt.c
+++ b/source/blender/editors/sculpt_paint/sculpt.c
@ -15,11 +15,11 @@
 *
 * The Original Code is Copyright (C) 2006 by Nicholas Bishop
 * All rights reserved.
- * Implements the Sculpt Mode tools
 */

 /** \file
 * \ingroup edsculpt
+ * Implements the Sculpt Mode tools.
 */

 #include "MEM_guardedalloc.h"
--- a/source/blender/editors/sculpt_paint/sculpt_brush_types.c
+++ b/source/blender/editors/sculpt_paint/sculpt_brush_types.c
@ -15,11 +15,11 @@
 *
 * The Original Code is Copyright (C) 2006 by Nicholas Bishop
 * All rights reserved.
- * Implements the Sculpt Mode tools
 */

 /** \file
 * \ingroup edsculpt
+ * Implements the Sculpt Mode tools.
 */

 #include "MEM_guardedalloc.h"
--- a/source/blender/editors/sculpt_paint/sculpt_ops.c
+++ b/source/blender/editors/sculpt_paint/sculpt_ops.c
@ -15,11 +15,11 @@
 *
 * The Original Code is Copyright (C) 2006 by Nicholas Bishop
 * All rights reserved.
- * Implements the Sculpt Mode tools
 */

 /** \file
 * \ingroup edsculpt
+ * Implements the Sculpt Mode tools.
 */

 #include "MEM_guardedalloc.h"
--- a/source/blender/editors/sculpt_paint/sculpt_undo.c
+++ b/source/blender/editors/sculpt_paint/sculpt_undo.c
@ -15,11 +15,11 @@
 *
 * The Original Code is Copyright (C) 2006 by Nicholas Bishop
 * All rights reserved.
- * Implements the Sculpt Mode tools
 */

 /** \file
 * \ingroup edsculpt
+ * Implements the Sculpt Mode tools.
 */

 #include <stddef.h>
--- a/source/blender/editors/sculpt_paint/sculpt_uv.c
+++ b/source/blender/editors/sculpt_paint/sculpt_uv.c
@ -15,11 +15,11 @@
 *
 * The Original Code is Copyright (C) Blender Foundation, 2002-2009
 * All rights reserved.
- * UV Sculpt tools
 */

 /** \file
 * \ingroup edsculpt
+ * UV Sculpt tools.
 */

 #include "MEM_guardedalloc.h"
--- a/source/blender/ikplugin/BIK_api.h
+++ b/source/blender/ikplugin/BIK_api.h
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * Original author: Benoit Bolsee
 */

 /** \file
--- a/source/blender/ikplugin/intern/ikplugin_api.c
+++ b/source/blender/ikplugin/intern/ikplugin_api.c
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * Original author: Benoit Bolsee
 */

 /** \file
--- a/source/blender/ikplugin/intern/ikplugin_api.h
+++ b/source/blender/ikplugin/intern/ikplugin_api.h
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * Original author: Benoit Bolsee
 */

 /** \file
--- a/source/blender/ikplugin/intern/iksolver_plugin.c
+++ b/source/blender/ikplugin/intern/iksolver_plugin.c
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * Original author: Benoit Bolsee
 */

 /** \file
--- a/source/blender/ikplugin/intern/iksolver_plugin.h
+++ b/source/blender/ikplugin/intern/iksolver_plugin.h
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * Original author: Benoit Bolsee
 */

 /** \file
--- a/source/blender/ikplugin/intern/itasc_plugin.cpp
+++ b/source/blender/ikplugin/intern/itasc_plugin.cpp
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * Original author: Benoit Bolsee
 */

 /** \file
--- a/source/blender/ikplugin/intern/itasc_plugin.h
+++ b/source/blender/ikplugin/intern/itasc_plugin.h
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * Original author: Benoit Bolsee
 */

 /** \file
--- a/source/blender/imbuf/intern/divers.c
+++ b/source/blender/imbuf/intern/divers.c
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * allocimbuf.c
 */

 /** \file
--- a/source/blender/imbuf/intern/filter.c
+++ b/source/blender/imbuf/intern/filter.c
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * filter.c
 */

 /** \file
--- a/source/blender/imbuf/intern/readimage.c
+++ b/source/blender/imbuf/intern/readimage.c
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * allocimbuf.c
 */

 /** \file
--- a/source/blender/imbuf/intern/rectop.c
+++ b/source/blender/imbuf/intern/rectop.c
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * allocimbuf.c
 */

 /** \file
--- a/source/blender/imbuf/intern/rotate.c
+++ b/source/blender/imbuf/intern/rotate.c
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * rotate.c
 */

 /** \file
--- a/source/blender/imbuf/intern/scaling.c
+++ b/source/blender/imbuf/intern/scaling.c
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * allocimbuf.c
 */

 /** \file
--- a/source/blender/imbuf/intern/util.c
+++ b/source/blender/imbuf/intern/util.c
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * util.c
 */

 /** \file
--- a/source/blender/imbuf/intern/util_gpu.c
+++ b/source/blender/imbuf/intern/util_gpu.c
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * util.c
 */

 /** \file
--- a/source/blender/imbuf/intern/writeimage.c
+++ b/source/blender/imbuf/intern/writeimage.c
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * writeimage.c
 */

 /** \file
--- a/source/blender/makesdna/DNA_constraint_types.h
+++ b/source/blender/makesdna/DNA_constraint_types.h
@ -15,11 +15,11 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * Constraint DNA data
 */

 /** \file
 * \ingroup DNA
+ * Constraint DNA data.
 */

 #pragma once
--- a/source/blender/makesdna/intern/dna_genfile.c
+++ b/source/blender/makesdna/intern/dna_genfile.c
@ -15,11 +15,11 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * DNA handling
 */

 /** \file
 * \ingroup DNA
+ * \brief DNA handling
 *
 * Lowest-level functions for decoding the parts of a saved .blend
 * file, including interpretation of its SDNA block and conversion of
--- a/source/blender/makesdna/intern/dna_rename_defs.h
+++ b/source/blender/makesdna/intern/dna_rename_defs.h
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
- * DNA handling
 */

 /** \file
--- a/source/blender/nodes/composite/nodes/node_composite_blur.cc
+++ b/source/blender/nodes/composite/nodes/node_composite_blur.cc
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2006 Blender Foundation.
 * All rights reserved.
- * Juho Vepsäläinen
 */

 /** \file
--- a/source/blender/nodes/composite/nodes/node_composite_bokehblur.cc
+++ b/source/blender/nodes/composite/nodes/node_composite_bokehblur.cc
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2006 Blender Foundation.
 * All rights reserved.
- * Juho Vepsäläinen
 */

 /** \file
--- a/source/blender/nodes/composite/nodes/node_composite_common.cc
+++ b/source/blender/nodes/composite/nodes/node_composite_common.cc
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2006 Blender Foundation.
 * All rights reserved.
- * Juho Vepsäläinen
 */

 /** \file
--- a/source/blender/nodes/composite/nodes/node_composite_switchview.cc
+++ b/source/blender/nodes/composite/nodes/node_composite_switchview.cc
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2006 Blender Foundation.
 * All rights reserved.
- * Dalai Felinto
 */

 /** \file
--- a/source/blender/nodes/shader/nodes/node_shader_common.cc
+++ b/source/blender/nodes/shader/nodes/node_shader_common.cc
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2006 Blender Foundation.
 * All rights reserved.
- * Juho Vepsäläinen
 */

 /** \file
--- a/source/blender/nodes/texture/nodes/node_texture_common.c
+++ b/source/blender/nodes/texture/nodes/node_texture_common.c
@ -15,7 +15,6 @@
 *
 * The Original Code is Copyright (C) 2006 Blender Foundation.
 * All rights reserved.
- * Juho Vepsäläinen
 */

 /** \file