achmizs/IRCClient
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated documentation

Browse Source
This commit is contained in:
achmizs 2015-12-19 08:29:12 -05:00
parent e882290630
commit 5686262717
8 changed files with 51 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
IRCClient.h
View File

@ -2,9 +2,11 @@
// IRCClient.h // IRCClient.h
// IRCClient // 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 * 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 * 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 * 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. //! Project version string for IRCClient.
FOUNDATION_EXPORT const unsigned char IRCClientVersionString[]; FOUNDATION_EXPORT const unsigned char IRCClientVersionString[];
// In this header, you should import all the public headers of your framework using statements like #import <IRCClient/PublicHeader.h>
#import "IRCClient/IRCClientSession.h" #import "IRCClient/IRCClientSession.h"
#import "IRCClient/IRCClientSessionDelegate.h" #import "IRCClient/IRCClientSessionDelegate.h"
#import "IRCClient/IRCClientChannel.h" #import "IRCClient/IRCClientChannel.h"

17
IRCClient/IRCClientChannel.h
View File

@ -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 * 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 * under the terms of the GNU Lesser General Public License as published by
@ -14,14 +17,6 @@
* License for more details. * License for more details.
*/ */
/**
* @file IRCClientChannel.h
* @author Nathan Ollerenshaw
* @version 1.0
* @date 01.2009
* @brief Represents a connected IRC Channel.
*/
#import <Cocoa/Cocoa.h> #import <Cocoa/Cocoa.h>
#import "IRCClientChannelDelegate.h" #import "IRCClientChannelDelegate.h"

9
IRCClient/IRCClientChannel.m
View File

@ -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 * 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 * under the terms of the GNU Lesser General Public License as published by

18
IRCClient/IRCClientChannelDelegate.h
View File

@ -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 * 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 * under the terms of the GNU Lesser General Public License as published by
@ -14,15 +17,6 @@
* License for more details. * 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 <Cocoa/Cocoa.h> #import <Cocoa/Cocoa.h>
/** @brief Receives delegate messages from an IRCClientChannel. /** @brief Receives delegate messages from an IRCClientChannel.

18
IRCClient/IRCClientChannel_Private.h
View File

@ -1,9 +1,19 @@
// //
// IRCClientChannel_Private.h // IRCClientChannel_Private.h
// Meil // IRCClient
// /*
// Copyright 2015 Said Achmiz (www.saidachmiz.net) * 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" #import "IRCClientChannel.h"
#include "libircclient.h" #include "libircclient.h"

11
IRCClient/IRCClientSession.h
View File

@ -1,3 +1,6 @@
//
// IRCClientSession.h
// IRCClient
/*! \mainpage IRCClient - a Cocoa IRC Framework to create IRC clients /*! \mainpage IRCClient - a Cocoa IRC Framework to create IRC clients
* *
* \section intro_sec Introduction * \section intro_sec Introduction
@ -54,14 +57,6 @@
* </PRE> * </PRE>
*/ */
/**
* @file IRCClientSession.h
* @author Nathan Ollerenshaw
* @version 1.0
* @date 01.2009
* @brief Represents a connected IRC Session.
*/
#import <Cocoa/Cocoa.h> #import <Cocoa/Cocoa.h>
#import "IRCClientSessionDelegate.h" #import "IRCClientSessionDelegate.h"

10
IRCClient/IRCClientSession.m
View File

@ -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 * 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 * under the terms of the GNU Lesser General Public License as published by
@ -21,7 +24,6 @@
#import "IRCClientSession.h" #import "IRCClientSession.h"
#import "IRCClientChannel.h" #import "IRCClientChannel.h"
#import "IRCClientChannel_Private.h" #import "IRCClientChannel_Private.h"
#include "libircclient.h"
#include "string.h" #include "string.h"
#pragma mark - Callback function declarations #pragma mark - Callback function declarations

18
IRCClient/IRCClientSessionDelegate.h
View File

@ -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 * 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 * under the terms of the GNU Lesser General Public License as published by
@ -16,15 +19,6 @@
#import <Cocoa/Cocoa.h> #import <Cocoa/Cocoa.h>
/**
* @file IRCClientSessionDelegate.h
* @author Nathan Ollerenshaw
* @version 1.0
* @date 01.2009
* @brief Receives delegate messages from an IRCClientSession.
* @protocol IRCClientSessionDelegate
*/
@class IRCClientChannel; @class IRCClientChannel;
/** @brief Receives delegate messages from an IRCClientSession. /** @brief Receives delegate messages from an IRCClientSession.