Cleanup: remove redundant doxygen \file argument
[blender.git] / intern / memutil / MEM_RefCountedC-Api.h
index 387c00a..9c5198a 100644 (file)
@@ -1,7 +1,4 @@
-/**
- * $Id$
- * ***** BEGIN GPL LICENSE BLOCK *****
- *
+/*
  * 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; either version 2
  *
  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  * All rights reserved.
- *
- * The Original Code is: all of this file.
- *
- * Contributor(s): none yet.
- *
- * ***** END GPL LICENSE BLOCK *****
  */
-/**
- * @file       MEM_RefCountedC-Api.h
+
+/** \file \ingroup memutil
+ *
  * Interface for C access to functionality relating to shared objects in the foundation library.
  */
 
-#ifndef _H_MEM_REF_COUNTED_C_API
-#define _H_MEM_REF_COUNTED_C_API
+#ifndef __MEM_REFCOUNTEDC_API_H__
+#define __MEM_REFCOUNTEDC_API_H__
 
 /** A pointer to a private object. */
 typedef struct MEM_TOpaqueObject* MEM_TObjectPtr;
@@ -44,23 +36,23 @@ extern "C" {
 #endif
 
 
-/** 
+/**
  * Returns the reference count of this object.
  * @param shared The object to query.
  * @return The current reference count.
  */
 extern int     MEM_RefCountedGetRef(MEM_TRefCountedObjectPtr shared);
 
-/** 
+/**
  * Increases the reference count of this object.
  * @param shared The object to query.
  * @return The new reference count.
  */
 extern int     MEM_RefCountedIncRef(MEM_TRefCountedObjectPtr shared);
 
-/** 
+/**
  * Decreases the reference count of this object.
- * If the the reference count reaches zero, the object self-destructs.
+ * If the reference count reaches zero, the object self-destructs.
  * @param shared The object to query.
  * @return The new reference count.
  */
@@ -71,5 +63,4 @@ extern int    MEM_RefCountedDecRef(MEM_TRefCountedObjectPtr shared);
 }
 #endif
 
-#endif // _H_MEM_REF_COUNTED_C_API
-
+#endif // __MEM_REFCOUNTEDC_API_H__