From 44b62866f83dea028500d81274eaaba8e886e1c3 Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 30 Mar 2003 12:32:32 +0000 Subject: Added DOT files to documentation for class diagrams (pretteh!) git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@169 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classFileReader.html | 91 +++++++++++++++++++----------------- 1 file changed, 47 insertions(+), 44 deletions(-) (limited to 'docs/module-doc/classFileReader.html') diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index 64b7ecd9c..5d67044cd 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -3,7 +3,7 @@ FileReader class Reference - +
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

FileReader Class Reference

Caches a text file into memory and can be used to retrieve lines from it. @@ -11,14 +11,17 @@

#include <modules.h>

-

Inheritance diagram for FileReader: -

- -classbase +Inheritance diagram for FileReader:

Inheritance graph
+ + -List of all members. +
[legend]
Collaboration diagram for FileReader:

Collaboration graph
+ + + +
[legend]
List of all members.
- + @@ -41,7 +44,7 @@ This class contains methods for read-only manipulation of a text file in memory.

-Definition at line 263 of file modules.h.


Constructor & Destructor Documentation

+Definition at line 264 of file modules.h.

Constructor & Destructor Documentation


Public Methods


Public Member Functions

 FileReader ()
 Default constructor.

 FileReader (string filename)
@@ -71,10 +74,10 @@ Default constructor.

This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.

-Definition at line 192 of file modules.cpp. +Definition at line 193 of file modules.cpp.

-

00193 {
-00194 }
+
00194 {
+00195 }
 
@@ -108,15 +111,15 @@ Secondary constructor.

This method initialises the class with a file loaded into it ready for GetLine and and other methods to be called. If the file could not be loaded, FileReader::FileSize returns 0.

-Definition at line 185 of file modules.cpp. +Definition at line 186 of file modules.cpp.

-References fc, and file_cache. +References fc, and file_cache.

-

00186 {
-00187         file_cache c;
-00188         readfile(c,filename.c_str());
-00189         this->fc = c;
-00190 }
+
00187 {
+00188         file_cache c;
+00189         readfile(c,filename.c_str());
+00190         this->fc = c;
+00191 }
 
@@ -149,10 +152,10 @@ Default destructor.

This deletes the memory allocated to the file.

-Definition at line 203 of file modules.cpp. +Definition at line 204 of file modules.cpp.

-

00204 {
-00205 }
+
00205 {
+00206 }
 
@@ -186,13 +189,13 @@ Returns the size of the file in lines.

This method returns the number of lines in the read file. If it is 0, no lines have been read into memory, either because the file is empty or it does not exist, or cannot be opened due to permission problems.

-Definition at line 214 of file modules.cpp. +Definition at line 215 of file modules.cpp.

-References fc. +References fc.

-

00215 {
-00216         return fc.size();
-00217 }
+
00216 {
+00217         return fc.size();
+00218 }
 
@@ -226,15 +229,15 @@ Retrieve one line from the file.

This method retrieves one line from the text file. If an empty non-NULL string is returned, the index was out of bounds, or the line had no data on it.

-Definition at line 207 of file modules.cpp. +Definition at line 208 of file modules.cpp.

-References fc. +References fc.

-

00208 {
-00209         if ((x<0) || (x>fc.size()))
-00210                 return "";
-00211         return fc[x];
-00212 }
+
00209 {
+00210         if ((x<0) || (x>fc.size()))
+00211                 return "";
+00212         return fc[x];
+00213 }
 
@@ -268,15 +271,15 @@ Used to load a file.

This method loads a file into the class ready for GetLine and and other methods to be called. If the file could not be loaded, FileReader::FileSize returns 0.

-Definition at line 196 of file modules.cpp. +Definition at line 197 of file modules.cpp.

-References fc, and file_cache. +References fc, and file_cache.

-

00197 {
-00198         file_cache c;
-00199         readfile(c,filename.c_str());
-00200         this->fc = c;
-00201 }
+
00198 {
+00199         file_cache c;
+00200         readfile(c,filename.c_str());
+00201         this->fc = c;
+00202 }
 
@@ -302,16 +305,16 @@ References fc, and

-Definition at line 265 of file modules.h. +Definition at line 266 of file modules.h.

-Referenced by FileReader(), FileSize(), GetLine(), and LoadFile(). +Referenced by FileReader(), FileSize(), GetLine(), and LoadFile().


The documentation for this class was generated from the following files: -
Generated on Sun Feb 9 12:48:18 2003 for InspIRCd by +
Generated on Sun Mar 30 13:28:59 2003 for InspIRCd by doxygen1.3-rc2
+width=110 height=53>1.3-rc3
-- cgit v1.3.1-10-gc9f91