Updated documentation

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

View File

@ -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 <IRCClient/PublicHeader.h>
#import "IRCClient/IRCClientSession.h"
#import "IRCClient/IRCClientSessionDelegate.h"
#import "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
* 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 <Cocoa/Cocoa.h>
#import "IRCClientChannelDelegate.h"

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

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
* 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 <Cocoa/Cocoa.h>
/** @brief Receives delegate messages from an IRCClientChannel.

View File

@ -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"

View File

@ -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 @@
* </PRE>
*/
/**
* @file IRCClientSession.h
* @author Nathan Ollerenshaw
* @version 1.0
* @date 01.2009
* @brief Represents a connected IRC Session.
*/
#import <Cocoa/Cocoa.h>
#import "IRCClientSessionDelegate.h"

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
* 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

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
* under the terms of the GNU Lesser General Public License as published by
@ -16,15 +19,6 @@
#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;
/** @brief Receives delegate messages from an IRCClientSession.