bug #69907: rs=brendan. Fix file-level comments in (to be) obsolete string files so they are clearer in LXR directory views.

This commit is contained in:
scc%mozilla.org 2001-02-23 02:43:42 +00:00
parent 56dcc94128
commit 98d9d2ebaf
14 changed files with 96 additions and 44 deletions

View File

@ -23,7 +23,10 @@
<body>
<h1><span class="LXRSHORTDESC">original string implementations soon to be replaced</span></h1>
<p>
<span class="LXRLONGDESC"></span>
<span class="LXRLONGDESC">These are the original string implementations by rickg and others.
Most of the code here will be made obsolete by the new shared-buffer string (see bug <a href="http://bugzilla.mozilla.org/show_bug.cgi?id=53065">#53065</a>).
If you're interested in learning how strings work, you probably want to start with
<a href="http://lxr.mozilla.org/seamonkey/source/string/public/nsAReadableString.h">nsAReadableString</a>.</span>
</p>
</body>
</html>

View File

@ -21,6 +21,13 @@
* Pierre Phaneuf <pp@ludusdesign.com>
*/
/* bufferRoutines.h --- rickg's original string manipulation underpinnings;
this code will be made obsolete by the new shared-buffer string (see bug #53065)
*/
#ifndef _BUFFERROUTINES_H
#define _BUFFERROUTINES_H
/******************************************************************************************
MODULE NOTES:
@ -31,9 +38,6 @@
*******************************************************************************************/
#ifndef _BUFFERROUTINES_H
#define _BUFFERROUTINES_H
#include "nsCRT.h"
#ifndef XPCOM_STANDALONE

View File

@ -24,6 +24,12 @@
* Scott Collins <scc@mozilla.org>
*/
#include "nsStr.h"
#include "bufferRoutines.h"
#include <stdio.h> //only used for printf
#include "nsCRT.h"
#include "nsDeque.h"
/******************************************************************************************
MODULE NOTES:
@ -36,12 +42,6 @@
*******************************************************************************************/
#include "nsStr.h"
#include "bufferRoutines.h"
#include <stdio.h> //only used for printf
#include "nsCRT.h"
#include "nsDeque.h"
//static const char* kCallFindChar = "For better performance, call FindChar() for targets whose length==1.";
//static const char* kCallRFindChar = "For better performance, call RFindChar() for targets whose length==1.";

View File

@ -22,6 +22,13 @@
* Scott Collins <scc@mozilla.org>
*/
/* nsStr.h --- the underlying buffer for rickg's original string implementations;
these classes will be replaced by the new shared-buffer string (see bug #53065)
*/
#ifndef _nsStr
#define _nsStr
/***********************************************************************
MODULE NOTES:
@ -181,9 +188,6 @@
**********************************************************************************/
#ifndef _nsStr
#define _nsStr
#include "nscore.h"
#include "nsMemory.h"
#include <string.h>

View File

@ -22,6 +22,13 @@
* Scott Collins <scc@mozilla.org>
*/
/* nsString.h --- rickg's original strings of 1-byte chars, |nsCString| and |nsCAutoString|;
these classes will be replaced by the new shared-buffer string (see bug #53065)
*/
#ifndef _nsCString_
#define _nsCString_
/***********************************************************************
MODULE NOTES:
@ -36,9 +43,6 @@
4. Subsumable strings
***********************************************************************/
#ifndef _nsCString_
#define _nsCString_
#include "nsString2.h"
#include "prtypes.h"
#include "nscore.h"

View File

@ -22,8 +22,15 @@
* Scott Collins <scc@mozilla.org>
*/
/* nsString2.h --- rickg's original strings of 2-byte chars, |nsString| and |nsAutoString|;
these classes will be replaced by the new shared-buffer string (see bug #53065)
*/
#ifndef _nsString_
#define _nsString_
/***********************************************************************
MODULE NOTES:
@ -37,9 +44,6 @@
4. Subsumable strings
***********************************************************************/
#ifndef _nsString_
#define _nsString_
#include "prtypes.h"
#include "nscore.h"
#include <stdio.h>

View File

@ -20,6 +20,16 @@
* Contributor(s):
*/
/* nsXPIDLString.h --- an `|auto_ptr|' for character buffers, this functionality will be replaced
by the new shared-buffer string (see bug #53065)
*/
#ifndef nsXPIDLString_h__
#define nsXPIDLString_h__
/*
A set of string wrapper classes that ease transition to use of XPIDL
@ -77,9 +87,6 @@
*/
#ifndef nsXPIDLString_h__
#define nsXPIDLString_h__
#include "nscore.h"
#include "nsCom.h"
#include "prtypes.h"

View File

@ -23,7 +23,10 @@
<body>
<h1><span class="LXRSHORTDESC">original string implementations soon to be replaced</span></h1>
<p>
<span class="LXRLONGDESC"></span>
<span class="LXRLONGDESC">These are the original string implementations by rickg and others.
Most of the code here will be made obsolete by the new shared-buffer string (see bug <a href="http://bugzilla.mozilla.org/show_bug.cgi?id=53065">#53065</a>).
If you're interested in learning how strings work, you probably want to start with
<a href="http://lxr.mozilla.org/seamonkey/source/string/public/nsAReadableString.h">nsAReadableString</a>.</span>
</p>
</body>
</html>

View File

@ -21,6 +21,13 @@
* Pierre Phaneuf <pp@ludusdesign.com>
*/
/* bufferRoutines.h --- rickg's original string manipulation underpinnings;
this code will be made obsolete by the new shared-buffer string (see bug #53065)
*/
#ifndef _BUFFERROUTINES_H
#define _BUFFERROUTINES_H
/******************************************************************************************
MODULE NOTES:
@ -31,9 +38,6 @@
*******************************************************************************************/
#ifndef _BUFFERROUTINES_H
#define _BUFFERROUTINES_H
#include "nsCRT.h"
#ifndef XPCOM_STANDALONE

View File

@ -24,6 +24,12 @@
* Scott Collins <scc@mozilla.org>
*/
#include "nsStr.h"
#include "bufferRoutines.h"
#include <stdio.h> //only used for printf
#include "nsCRT.h"
#include "nsDeque.h"
/******************************************************************************************
MODULE NOTES:
@ -36,12 +42,6 @@
*******************************************************************************************/
#include "nsStr.h"
#include "bufferRoutines.h"
#include <stdio.h> //only used for printf
#include "nsCRT.h"
#include "nsDeque.h"
//static const char* kCallFindChar = "For better performance, call FindChar() for targets whose length==1.";
//static const char* kCallRFindChar = "For better performance, call RFindChar() for targets whose length==1.";

View File

@ -22,6 +22,13 @@
* Scott Collins <scc@mozilla.org>
*/
/* nsStr.h --- the underlying buffer for rickg's original string implementations;
these classes will be replaced by the new shared-buffer string (see bug #53065)
*/
#ifndef _nsStr
#define _nsStr
/***********************************************************************
MODULE NOTES:
@ -181,9 +188,6 @@
**********************************************************************************/
#ifndef _nsStr
#define _nsStr
#include "nscore.h"
#include "nsMemory.h"
#include <string.h>

View File

@ -22,6 +22,13 @@
* Scott Collins <scc@mozilla.org>
*/
/* nsString.h --- rickg's original strings of 1-byte chars, |nsCString| and |nsCAutoString|;
these classes will be replaced by the new shared-buffer string (see bug #53065)
*/
#ifndef _nsCString_
#define _nsCString_
/***********************************************************************
MODULE NOTES:
@ -36,9 +43,6 @@
4. Subsumable strings
***********************************************************************/
#ifndef _nsCString_
#define _nsCString_
#include "nsString2.h"
#include "prtypes.h"
#include "nscore.h"

View File

@ -22,8 +22,15 @@
* Scott Collins <scc@mozilla.org>
*/
/* nsString2.h --- rickg's original strings of 2-byte chars, |nsString| and |nsAutoString|;
these classes will be replaced by the new shared-buffer string (see bug #53065)
*/
#ifndef _nsString_
#define _nsString_
/***********************************************************************
MODULE NOTES:
@ -37,9 +44,6 @@
4. Subsumable strings
***********************************************************************/
#ifndef _nsString_
#define _nsString_
#include "prtypes.h"
#include "nscore.h"
#include <stdio.h>

View File

@ -20,6 +20,16 @@
* Contributor(s):
*/
/* nsXPIDLString.h --- an `|auto_ptr|' for character buffers, this functionality will be replaced
by the new shared-buffer string (see bug #53065)
*/
#ifndef nsXPIDLString_h__
#define nsXPIDLString_h__
/*
A set of string wrapper classes that ease transition to use of XPIDL
@ -77,9 +87,6 @@
*/
#ifndef nsXPIDLString_h__
#define nsXPIDLString_h__
#include "nscore.h"
#include "nsCom.h"
#include "prtypes.h"