From 5686262717fa1fc3f0a9667a351043f6fb27b258 Mon Sep 17 00:00:00 2001 From: achmizs Date: Sat, 19 Dec 2015 08:29:12 -0500 Subject: [PATCH] Updated documentation --- IRCClient.h | 8 ++++---- IRCClient/IRCClientChannel.h | 17 ++++++----------- IRCClient/IRCClientChannel.m | 9 ++++++--- IRCClient/IRCClientChannelDelegate.h | 18 ++++++------------ IRCClient/IRCClientChannel_Private.h | 18 ++++++++++++++---- IRCClient/IRCClientSession.h | 11 +++-------- IRCClient/IRCClientSession.m | 10 ++++++---- IRCClient/IRCClientSessionDelegate.h | 18 ++++++------------ 8 files changed, 51 insertions(+), 58 deletions(-) diff --git a/IRCClient.h b/IRCClient.h index bde11eb..2d04cf5 100644 --- a/IRCClient.h +++ b/IRCClient.h @@ -2,9 +2,11 @@ // IRCClient.h // IRCClient // -// Copyright © 2015 Said Achmiz. -// /* + * Modified IRCClient Copyright 2015 Said Achmiz (www.saidachmiz.net) + * + * Original IRCClient Copyright (C) 2009 Nathan Ollerenshaw chrome@stupendous.net + * * This library is free software; you can redistribute it and/or modify it * under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation; either version 2 of the License, or (at your @@ -24,8 +26,6 @@ FOUNDATION_EXPORT double IRCClientVersionNumber; //! Project version string for IRCClient. FOUNDATION_EXPORT const unsigned char IRCClientVersionString[]; -// In this header, you should import all the public headers of your framework using statements like #import - #import "IRCClient/IRCClientSession.h" #import "IRCClient/IRCClientSessionDelegate.h" #import "IRCClient/IRCClientChannel.h" diff --git a/IRCClient/IRCClientChannel.h b/IRCClient/IRCClientChannel.h index dada882..144530b 100644 --- a/IRCClient/IRCClientChannel.h +++ b/IRCClient/IRCClientChannel.h @@ -1,7 +1,10 @@ -/* - * Modified IRCClient Copyright 2015 Said Achmiz (www.saidachmiz.net) +// +// IRCClientChannel.h +// IRCClient +/* + * Copyright 2015 Said Achmiz (www.saidachmiz.net) * - * Original IRCClient Copyright (C) 2009 Nathan Ollerenshaw chrome@stupendous.net + * Copyright (C) 2009 Nathan Ollerenshaw chrome@stupendous.net * * This library is free software; you can redistribute it and/or modify it * under the terms of the GNU Lesser General Public License as published by @@ -14,14 +17,6 @@ * License for more details. */ -/** - * @file IRCClientChannel.h - * @author Nathan Ollerenshaw - * @version 1.0 - * @date 01.2009 - * @brief Represents a connected IRC Channel. - */ - #import #import "IRCClientChannelDelegate.h" diff --git a/IRCClient/IRCClientChannel.m b/IRCClient/IRCClientChannel.m index 10dbce5..940f44a 100644 --- a/IRCClient/IRCClientChannel.m +++ b/IRCClient/IRCClientChannel.m @@ -1,7 +1,10 @@ -/* - * Modified IRCClient Copyright 2015 Said Achmiz (www.saidachmiz.net) +// +// IRCClientChannel.m +// IRCClient +/* + * Copyright 2015 Said Achmiz (www.saidachmiz.net) * - * Original IRCClient Copyright (C) 2009 Nathan Ollerenshaw chrome@stupendous.net + * Copyright (C) 2009 Nathan Ollerenshaw chrome@stupendous.net * * This library is free software; you can redistribute it and/or modify it * under the terms of the GNU Lesser General Public License as published by diff --git a/IRCClient/IRCClientChannelDelegate.h b/IRCClient/IRCClientChannelDelegate.h index 34053e9..c0ef7bf 100644 --- a/IRCClient/IRCClientChannelDelegate.h +++ b/IRCClient/IRCClientChannelDelegate.h @@ -1,7 +1,10 @@ -/* - * Modified IRCClient Copyright 2015 Said Achmiz (www.saidachmiz.net) +// +// IRCClientChannelDelegate.h +// IRCClient +/* + * Copyright 2015 Said Achmiz (www.saidachmiz.net) * - * Original IRCClient Copyright (C) 2009 Nathan Ollerenshaw chrome@stupendous.net + * Copyright (C) 2009 Nathan Ollerenshaw chrome@stupendous.net * * This library is free software; you can redistribute it and/or modify it * under the terms of the GNU Lesser General Public License as published by @@ -14,15 +17,6 @@ * License for more details. */ -/** - * @file IRCClientChannelDelegate.h - * @author Nathan Ollerenshaw - * @version 1.0 - * @date 01.2009 - * @brief Receives delegate messages from an IRCClientChannel. - * @protocol IRCClientChannelDelegate - */ - #import /** @brief Receives delegate messages from an IRCClientChannel. diff --git a/IRCClient/IRCClientChannel_Private.h b/IRCClient/IRCClientChannel_Private.h index d54349b..a1fb07b 100644 --- a/IRCClient/IRCClientChannel_Private.h +++ b/IRCClient/IRCClientChannel_Private.h @@ -1,9 +1,19 @@ // // IRCClientChannel_Private.h -// Meil -// -// Copyright 2015 Said Achmiz (www.saidachmiz.net) -// +// IRCClient +/* + * Copyright 2015 Said Achmiz (www.saidachmiz.net) + * + * This library is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation; either version 2 of the License, or (at your + * option) any later version. + * + * This library 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 Lesser General Public + * License for more details. + */ #import "IRCClientChannel.h" #include "libircclient.h" diff --git a/IRCClient/IRCClientSession.h b/IRCClient/IRCClientSession.h index 6847685..f1725df 100644 --- a/IRCClient/IRCClientSession.h +++ b/IRCClient/IRCClientSession.h @@ -1,3 +1,6 @@ +// +// IRCClientSession.h +// IRCClient /*! \mainpage IRCClient - a Cocoa IRC Framework to create IRC clients * * \section intro_sec Introduction @@ -54,14 +57,6 @@ * */ -/** - * @file IRCClientSession.h - * @author Nathan Ollerenshaw - * @version 1.0 - * @date 01.2009 - * @brief Represents a connected IRC Session. - */ - #import #import "IRCClientSessionDelegate.h" diff --git a/IRCClient/IRCClientSession.m b/IRCClient/IRCClientSession.m index 62a496d..6feb8ff 100644 --- a/IRCClient/IRCClientSession.m +++ b/IRCClient/IRCClientSession.m @@ -1,7 +1,10 @@ -/* - * Modified IRCClient Copyright 2015 Said Achmiz (www.saidachmiz.net) +// +// IRCClientSession.m +// IRCClient +/* + * Copyright 2015 Said Achmiz (www.saidachmiz.net) * - * Original IRCClient Copyright (C) 2009 Nathan Ollerenshaw chrome@stupendous.net + * Copyright (C) 2009 Nathan Ollerenshaw chrome@stupendous.net * * This library is free software; you can redistribute it and/or modify it * under the terms of the GNU Lesser General Public License as published by @@ -21,7 +24,6 @@ #import "IRCClientSession.h" #import "IRCClientChannel.h" #import "IRCClientChannel_Private.h" -#include "libircclient.h" #include "string.h" #pragma mark - Callback function declarations diff --git a/IRCClient/IRCClientSessionDelegate.h b/IRCClient/IRCClientSessionDelegate.h index 38244ed..056032c 100644 --- a/IRCClient/IRCClientSessionDelegate.h +++ b/IRCClient/IRCClientSessionDelegate.h @@ -1,7 +1,10 @@ -/* - * Modified IRCClient Copyright 2015 Said Achmiz (www.saidachmiz.net) +// +// IRCClientSessionDelegate.h +// IRCClient +/* + * Copyright 2015 Said Achmiz (www.saidachmiz.net) * - * Original IRCClient Copyright (C) 2009 Nathan Ollerenshaw chrome@stupendous.net + * Copyright (C) 2009 Nathan Ollerenshaw chrome@stupendous.net * * This library is free software; you can redistribute it and/or modify it * under the terms of the GNU Lesser General Public License as published by @@ -16,15 +19,6 @@ #import -/** - * @file IRCClientSessionDelegate.h - * @author Nathan Ollerenshaw - * @version 1.0 - * @date 01.2009 - * @brief Receives delegate messages from an IRCClientSession. - * @protocol IRCClientSessionDelegate - */ - @class IRCClientChannel; /** @brief Receives delegate messages from an IRCClientSession.