Cleanup: move file descriptions into doxygen file section

Continuation of 19100aa57d847699d17527b76c2fab1f4ab88885.
This commit is contained in:
Campbell Barton 2022-02-09 18:31:42 +11:00
parent 19100aa57d
commit 81da638c44
52 changed files with 33 additions and 62 deletions

@ -13,11 +13,9 @@
* along with this program; if not, write to the Free Software Foundation, * along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* *
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV. * Copyright 2001-2002 NaN Holding BV. All rights reserved.
* All rights reserved. * 1997-2001 Id Software, Inc. Video mode switching.
* Video mode switching Ported from Quake 2 by Alex Fraser <alex@phatcore.com>.
* Copyright (C) 1997-2001 Id Software, Inc.
* Ported from Quake 2 by Alex Fraser <alex@phatcore.com>
*/ */
/** \file /** \file

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

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

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

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

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

@ -15,11 +15,11 @@
* *
* The Original Code is Copyright (C) 2006 Blender Foundation. * The Original Code is Copyright (C) 2006 Blender Foundation.
* All rights reserved. * All rights reserved.
* Implementation of CDDerivedMesh.
*/ */
/** \file /** \file
* \ingroup bke * \ingroup bke
* Implementation of #CDDerivedMesh.
* BKE_cdderivedmesh.h contains the function prototypes for this file. * BKE_cdderivedmesh.h contains the function prototypes for this file.
*/ */

@ -15,11 +15,11 @@
* *
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV. * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved. * All rights reserved.
* Functions for writing avi-format files.
* Added interface for generic movie support (ton)
*/ */
/** \file /** \file
* Functions for writing avi-format files.
* Added interface for generic movie support (ton)
* \ingroup bke * \ingroup bke
*/ */

@ -15,11 +15,11 @@
* *
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV. * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved. * All rights reserved.
* Dynamically sized string ADT
*/ */
/** \file /** \file
* \ingroup bli * \ingroup bli
* Dynamically sized string ADT.
*/ */
#include <stdio.h> #include <stdio.h>

@ -15,7 +15,6 @@
* *
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV. * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved. * All rights reserved.
* Support for linked lists.
*/ */
/** \file /** \file

@ -15,11 +15,11 @@
* *
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV. * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved. * All rights reserved.
* various string, file, list operations.
*/ */
/** \file /** \file
* \ingroup bli * \ingroup bli
* Various string, file, list operations.
*/ */
#include <ctype.h> #include <ctype.h>

@ -15,11 +15,11 @@
* *
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV. * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved. * All rights reserved.
* Windows-posix compatibility layer, windows-specific functions.
*/ */
/** \file /** \file
* \ingroup bli * \ingroup bli
* Windows-posix compatibility layer, windows-specific functions.
*/ */
#ifdef WIN32 #ifdef WIN32

@ -15,13 +15,13 @@
* *
* The Original Code is Copyright (C) 2004 Blender Foundation. * The Original Code is Copyright (C) 2004 Blender Foundation.
* All rights reserved. * All rights reserved.
* external writefile function prototypes
*/ */
#pragma once #pragma once
/** \file /** \file
* \ingroup blenloader * \ingroup blenloader
* External writefile function prototypes.
*/ */
#include "BLI_filereader.h" #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. * Not memfile itself.
*/ */
/* **************** support for memory-write, for undo buffers *************** */
extern void BLO_memfile_free(MemFile *memfile); extern void BLO_memfile_free(MemFile *memfile);
/** /**
* Result is that 'first' is being freed. * Result is that 'first' is being freed.

@ -15,11 +15,11 @@
* *
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV. * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved. * All rights reserved.
* Operators and API's for creating bones
*/ */
/** \file /** \file
* \ingroup edarmature * \ingroup edarmature
* Operators and API's for creating bones.
*/ */
#include "DNA_anim_types.h" #include "DNA_anim_types.h"

@ -15,11 +15,11 @@
* *
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV. * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved. * All rights reserved.
* Armature EditMode tools - transforms, chain based editing, and other settings
*/ */
/** \file /** \file
* \ingroup edarmature * \ingroup edarmature
* Armature EditMode tools - transforms, chain based editing, and other settings.
*/ */
#include "DNA_armature_types.h" #include "DNA_armature_types.h"

@ -15,11 +15,11 @@
* *
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV. * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved. * All rights reserved.
* Operators and API's for renaming bones both in and out of Edit Mode
*/ */
/** \file /** \file
* \ingroup edarmature * \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. * This file contains functions/API's for renaming bones and/or working with them.
*/ */

@ -15,11 +15,11 @@
* *
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV. * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved. * All rights reserved.
* Operators for relations between bones and for transferring bones between armature objects
*/ */
/** \file /** \file
* \ingroup edarmature * \ingroup edarmature
* Operators for relations between bones and for transferring bones between armature objects.
*/ */
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"

@ -15,11 +15,11 @@
* *
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV. * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved. * All rights reserved.
* API's and Operators for selecting armature bones in EditMode
*/ */
/** \file /** \file
* \ingroup edarmature * \ingroup edarmature
* API's and Operators for selecting armature bones in EditMode.
*/ */
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"

@ -15,12 +15,12 @@
* *
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV. * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved. * All rights reserved.
* API's for creating vertex groups from bones
* - Interfaces with heat weighting in meshlaplacian
*/ */
/** \file /** \file
* \ingroup edarmature * \ingroup edarmature
* API's for creating vertex groups from bones
* - Interfaces with heat weighting in meshlaplacian.
*/ */
#include "DNA_armature_types.h" #include "DNA_armature_types.h"

@ -15,12 +15,12 @@
* *
* The Original Code is Copyright (C) 2008 Blender Foundation. * The Original Code is Copyright (C) 2008 Blender Foundation.
* All rights reserved. * All rights reserved.
* Generic 2d view with should allow drawing grids,
* panning, zooming, scrolling, ..
*/ */
/** \file /** \file
* \ingroup editorui * \ingroup editorui
* Generic 2D view with should allow drawing grids,
* panning, zooming, scrolling, .. etc.
*/ */
#pragma once #pragma once

@ -15,11 +15,11 @@
* *
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV. * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved. * All rights reserved.
* Making screendumps.
*/ */
/** \file /** \file
* \ingroup edscr * \ingroup edscr
* Making screenshots of the entire window or sub-regions.
*/ */
#include <errno.h> #include <errno.h>

@ -15,11 +15,11 @@
* *
* The Original Code is Copyright (C) 2010 by Nicholas Bishop * The Original Code is Copyright (C) 2010 by Nicholas Bishop
* All rights reserved. * All rights reserved.
* Implements the PBVH node hiding operator
*/ */
/** \file /** \file
* \ingroup edsculpt * \ingroup edsculpt
* Implements the PBVH node hiding operator.
*/ */
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"

@ -15,11 +15,11 @@
* *
* The Original Code is Copyright (C) 2006 by Nicholas Bishop * The Original Code is Copyright (C) 2006 by Nicholas Bishop
* All rights reserved. * All rights reserved.
* Implements the Sculpt Mode tools
*/ */
/** \file /** \file
* \ingroup edsculpt * \ingroup edsculpt
* Implements the Sculpt Mode tools.
*/ */
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"

@ -15,11 +15,11 @@
* *
* The Original Code is Copyright (C) 2006 by Nicholas Bishop * The Original Code is Copyright (C) 2006 by Nicholas Bishop
* All rights reserved. * All rights reserved.
* Implements the Sculpt Mode tools
*/ */
/** \file /** \file
* \ingroup edsculpt * \ingroup edsculpt
* Implements the Sculpt Mode tools.
*/ */
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"

@ -15,11 +15,11 @@
* *
* The Original Code is Copyright (C) 2006 by Nicholas Bishop * The Original Code is Copyright (C) 2006 by Nicholas Bishop
* All rights reserved. * All rights reserved.
* Implements the Sculpt Mode tools
*/ */
/** \file /** \file
* \ingroup edsculpt * \ingroup edsculpt
* Implements the Sculpt Mode tools.
*/ */
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"

@ -15,11 +15,11 @@
* *
* The Original Code is Copyright (C) 2006 by Nicholas Bishop * The Original Code is Copyright (C) 2006 by Nicholas Bishop
* All rights reserved. * All rights reserved.
* Implements the Sculpt Mode tools
*/ */
/** \file /** \file
* \ingroup edsculpt * \ingroup edsculpt
* Implements the Sculpt Mode tools.
*/ */
#include <stddef.h> #include <stddef.h>

@ -15,11 +15,11 @@
* *
* The Original Code is Copyright (C) Blender Foundation, 2002-2009 * The Original Code is Copyright (C) Blender Foundation, 2002-2009
* All rights reserved. * All rights reserved.
* UV Sculpt tools
*/ */
/** \file /** \file
* \ingroup edsculpt * \ingroup edsculpt
* UV Sculpt tools.
*/ */
#include "MEM_guardedalloc.h" #include "MEM_guardedalloc.h"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@ -15,11 +15,11 @@
* *
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV. * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved. * All rights reserved.
* Constraint DNA data
*/ */
/** \file /** \file
* \ingroup DNA * \ingroup DNA
* Constraint DNA data.
*/ */
#pragma once #pragma once

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

@ -15,7 +15,6 @@
* *
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV. * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved. * All rights reserved.
* DNA handling
*/ */
/** \file /** \file

@ -15,7 +15,6 @@
* *
* The Original Code is Copyright (C) 2006 Blender Foundation. * The Original Code is Copyright (C) 2006 Blender Foundation.
* All rights reserved. * All rights reserved.
* Juho Vepsäläinen
*/ */
/** \file /** \file

@ -15,7 +15,6 @@
* *
* The Original Code is Copyright (C) 2006 Blender Foundation. * The Original Code is Copyright (C) 2006 Blender Foundation.
* All rights reserved. * All rights reserved.
* Juho Vepsäläinen
*/ */
/** \file /** \file

@ -15,7 +15,6 @@
* *
* The Original Code is Copyright (C) 2006 Blender Foundation. * The Original Code is Copyright (C) 2006 Blender Foundation.
* All rights reserved. * All rights reserved.
* Juho Vepsäläinen
*/ */
/** \file /** \file

@ -15,7 +15,6 @@
* *
* The Original Code is Copyright (C) 2006 Blender Foundation. * The Original Code is Copyright (C) 2006 Blender Foundation.
* All rights reserved. * All rights reserved.
* Dalai Felinto
*/ */
/** \file /** \file

@ -15,7 +15,6 @@
* *
* The Original Code is Copyright (C) 2006 Blender Foundation. * The Original Code is Copyright (C) 2006 Blender Foundation.
* All rights reserved. * All rights reserved.
* Juho Vepsäläinen
*/ */
/** \file /** \file

@ -15,7 +15,6 @@
* *
* The Original Code is Copyright (C) 2006 Blender Foundation. * The Original Code is Copyright (C) 2006 Blender Foundation.
* All rights reserved. * All rights reserved.
* Juho Vepsäläinen
*/ */
/** \file /** \file