fixed a few clang -Wdocumentation warnings, comments only

nathanday · Jun 27, 2013 · 86d985c · 86d985c
1 parent e2e9785
commit 86d985c
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 13 deletions.
diff --git a/Classes/NDResourceFork.h b/Classes/NDResourceFork.h
@@ -2,7 +2,7 @@
 	NDResourceFork.h category
 
 	Created by Nathan Day on 05.12.01 under a MIT-style license.
-	Copyright (c) 2008-2012 Nathan Day
+	Copyright (c) 2008-2013 Nathan Day
 
 	Permission is hereby granted, free of charge, to any person obtaining a copy
 	of this software and associated documentation files (the "Software"), to deal
@@ -113,10 +113,7 @@
 - (instancetype)initForWritingAtPath:(NSString *)path;
 /*!
 	@method closeFile
-	@abstract
-	@discussion
-	@param
-	@result
+	@abstract Closes the resource file.
  */
 - (void)closeFile;
 /*!

diff --git a/Classes/NSSavePanel+NDAlias.h b/Classes/NSSavePanel+NDAlias.h
@@ -2,7 +2,7 @@
 	NSSavePanel+NDAlias.h
 
 	Created by Sean McBride on 18.08.07 under a MIT-style license.
-	Copyright (c) 2008-2011 Nathan Day
+	Copyright (c) 2008-2013 Nathan Day
 
 	Permission is hereby granted, free of charge, to any person obtaining a copy
 	of this software and associated documentation files (the "Software"), to deal
@@ -55,7 +55,6 @@
 	@method setDirectoryAlias
 	@abstract Sets the current directory currently shown in the receiver to the alias given. Does nothing if the alias cannot be resolved.
 	@discussion Works in a similiar way to -[NSSavePanel setDirectory].
-	@result
   */
 - (void)setDirectoryAlias:(NDAlias*)alias;
 

diff --git a/Classes/NSString+NDCarbonUtilities.h b/Classes/NSString+NDCarbonUtilities.h
@@ -2,7 +2,7 @@
 	NSString+NDCarbonUtilities.h
 
 	Created by Nathan Day on 03.08.02 under a MIT-style license.
-	Copyright (c) 2008-2011 Nathan Day
+	Copyright (c) 2008-2013 Nathan Day
 
 	Permission is hereby granted, free of charge, to any person obtaining a copy
 	of this software and associated documentation files (the "Software"), to deal
@@ -261,39 +261,39 @@
 	@method setIsStationeryFinderInfoFlag:
 	@abstract <#abstract#>
 	@discussion <#discussion#>
-	@param flag <#discussion#>
+	@param aFlag <#discussion#>
 	@result <#result#>
  */
 - (BOOL)setIsStationeryFinderInfoFlag:(BOOL)aFlag;
 /*!
 	@method setHasNameLockedFinderInfoFlag:
 	@abstract <#abstract#>
 	@discussion <#discussion#>
-	@param flag <#discussion#>
+	@param aFlag <#discussion#>
 	@result <#result#>
  */
 - (BOOL)setHasNameLockedFinderInfoFlag:(BOOL)aFlag;
 /*!
 	@method setHasBundleFinderInfoFlag:
 	@abstract <#abstract#>
 	@discussion <#discussion#>
-	@param flag <#discussion#>
+	@param aFlag <#discussion#>
 	@result <#result#>
  */
 - (BOOL)setHasBundleFinderInfoFlag:(BOOL)aFlag;
 /*!
 	@method setIsInvisibleFinderInfoFlag:
 	@abstract <#abstract#>
 	@discussion <#discussion#>
-	@param flag <#discussion#>
+	@param aFlag <#discussion#>
 	@result <#result#>
  */
 - (BOOL)setIsInvisibleFinderInfoFlag:(BOOL)aFlag;
 /*!
 	@method setIsAliasFinderInfoFlag:
 	@abstract <#abstract#>
 	@discussion <#discussion#>
-	@param flag <#discussion#>
+	@param aFlag <#discussion#>
 	@result <#result#>
  */
 - (BOOL)setIsAliasFinderInfoFlag:(BOOL)aFlag;