mirror of
https://github.com/MariaDB/server.git
synced 2025-01-24 07:44:22 +01:00
e6c01608be
(Ran doxygenify.pl conversion locally, then merged and checked consistency.)
------------------------------------------------------------------------
r5091 | marko | 2009-05-25 09:30:14 +0300 (Mon, 25 May 2009) | 33 lines
branches/zip: Convert the function comments to Doxygen format.
This patch was created by running the following commands:
for i in */*[ch]; do doxygenify.pl $i; done
perl -i -pe 's#\*{3} \*/$#****/#' */*[ch]
where doxygenify.pl is
https://svn.innodb.com/svn/misc/trunk/tools/doxygenify.pl r510
Verified the consistency as follows:
(0) not too many /* in: */ or /* out: */ comments left in the code:
grep -l '/\*\s*\(in\|out\)[,:/]' */*[ch]
(1) no difference when ignoring blank lines, after stripping all
C90-style /* comments */, including multi-line ones, before and after
applying this patch:
perl -i -e 'undef $/;while(<ARGV>){s#/\*(.*?)\*/##gs;print}' */*[ch]
diff -I'^\s*$' --exclude .svn -ru TREE1 TREE2
(2) after stripping @return comments and !<, generated a diff and omitted
the hunks where /* out: */ function return comments were removed:
perl -i -e'undef $/;while(<ARGV>){s#!<##g;s#\n\@return\t.*?\*/# \*/#gs;print}'\
*/*[ch]
svn diff|
perl -e 'undef $/;$_=<>;s#\n-\s*/\* out[:,]([^\n]*?)(\n-[^\n]*?)*\*/##gs;print'
Some unintended changes were left. These will be removed in a
subsequent patch.
------------------------------------------------------------------------
89 lines
2.4 KiB
Text
89 lines
2.4 KiB
Text
/*****************************************************************************
|
|
|
|
Copyright (c) 2006, 2009, Innobase Oy. All Rights Reserved.
|
|
|
|
This program is free software; you can redistribute it and/or modify it under
|
|
the terms of the GNU General Public License as published by the Free Software
|
|
Foundation; version 2 of the License.
|
|
|
|
This program is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License along with
|
|
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
|
|
Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
*****************************************************************************/
|
|
|
|
/********************************************************************
|
|
Get number of elements in vector.
|
|
@return number of elements in vector */
|
|
UNIV_INLINE
|
|
ulint
|
|
ib_vector_size(
|
|
/*===========*/
|
|
const ib_vector_t* vec) /*!< in: vector */
|
|
{
|
|
return(vec->used);
|
|
}
|
|
|
|
/********************************************************************
|
|
Get n'th element.
|
|
@return n'th element */
|
|
UNIV_INLINE
|
|
void*
|
|
ib_vector_get(
|
|
/*==========*/
|
|
ib_vector_t* vec, /*!< in: vector */
|
|
ulint n) /*!< in: element index to get */
|
|
{
|
|
ut_a(n < vec->used);
|
|
|
|
return(vec->data[n]);
|
|
}
|
|
|
|
/********************************************************************
|
|
Remove the last element from the vector.
|
|
@return last vector element */
|
|
UNIV_INLINE
|
|
void*
|
|
ib_vector_pop(
|
|
/*==========*/
|
|
ib_vector_t* vec) /*!< in/out: vector */
|
|
{
|
|
void* elem;
|
|
|
|
ut_a(vec->used > 0);
|
|
--vec->used;
|
|
elem = vec->data[vec->used];
|
|
|
|
ut_d(vec->data[vec->used] = NULL);
|
|
UNIV_MEM_INVALID(&vec->data[vec->used], sizeof(*vec->data));
|
|
|
|
return(elem);
|
|
}
|
|
|
|
/********************************************************************
|
|
Free the underlying heap of the vector. Note that vec is invalid
|
|
after this call. */
|
|
UNIV_INLINE
|
|
void
|
|
ib_vector_free(
|
|
/*===========*/
|
|
ib_vector_t* vec) /*!< in, own: vector */
|
|
{
|
|
mem_heap_free(vec->heap);
|
|
}
|
|
|
|
/********************************************************************
|
|
Test whether a vector is empty or not.
|
|
@return TRUE if empty */
|
|
UNIV_INLINE
|
|
ibool
|
|
ib_vector_is_empty(
|
|
/*===============*/
|
|
const ib_vector_t* vec) /*!< in: vector */
|
|
{
|
|
return(ib_vector_size(vec) == 0);
|
|
}
|