mirror of
https://github.com/gnustep/libs-base.git
synced 2025-04-22 16:33:29 +00:00
Better docs
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@17056 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-Macdonald
parent
9b176a1e62
commit
8cbd3a5b00
2 changed files with 55 additions and 8 deletions
|
|
@ -123,7 +123,7 @@ GSObjCSetValue(NSObject *self, NSString *key, id val, SEL sel,
|
|||
|
||||
#define GS_STATIC_INLINE static inline
|
||||
|
||||
/*
|
||||
/**
|
||||
* GSObjCClass() return the class of an instance.
|
||||
* The argument to this function must NOT be nil.
|
||||
*/
|
||||
|
|
@ -133,7 +133,7 @@ GSObjCClass(id obj)
|
|||
return obj->class_pointer;
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* GSObjCIsInstance() tests to see if an id is an instance.
|
||||
* The argument to this function must NOT be nil.
|
||||
*/
|
||||
|
|
@ -143,7 +143,7 @@ GSObjCIsInstance(id obj)
|
|||
return CLS_ISCLASS(obj->class_pointer);
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* GSObjCIsKindOf() tests to see if a class inherits from another class
|
||||
* The argument to this function must NOT be nil.
|
||||
*/
|
||||
|
|
@ -366,28 +366,33 @@ GSFlushMethodCacheForClass (Class class)
|
|||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Returns the superclass of this.
|
||||
*/
|
||||
GS_STATIC_INLINE Class
|
||||
GSObjCSuper(Class this)
|
||||
{
|
||||
return class_get_super_class(this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the version number of this.
|
||||
*/
|
||||
GS_STATIC_INLINE int
|
||||
GSObjCVersion(Class this)
|
||||
{
|
||||
return class_get_version(this);
|
||||
}
|
||||
|
||||
/*
|
||||
* Return the zone in which an object belongs, without using the zone method
|
||||
*/
|
||||
#ifndef NeXT_Foundation_LIBRARY
|
||||
#include <Foundation/NSZone.h>
|
||||
#else
|
||||
#include <Foundation/Foundation.h>
|
||||
#endif
|
||||
|
||||
/**
|
||||
* Return the zone in which an object belongs, without using the zone method
|
||||
*/
|
||||
GS_EXPORT NSZone *
|
||||
GSObjCZone(NSObject *obj);
|
||||
|
||||
|
|
@ -397,7 +402,8 @@ GSObjCZone(NSObject *obj);
|
|||
GS_EXPORT void *
|
||||
GSAutoreleasedBuffer(unsigned size);
|
||||
|
||||
/* Getting a system error message on a variety of systems */
|
||||
/** Returns a system error message on a variety of systems
|
||||
*/
|
||||
GS_EXPORT const char *
|
||||
GSLastErrorStr(long error_id);
|
||||
|
||||
|
|
|
|||
|
|
@ -364,6 +364,10 @@ static BOOL shouldBeCompact = NO;
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts the supplied propertyList into a serialized representation
|
||||
* in the returned NSData object.
|
||||
*/
|
||||
+ (NSData*) serializePropertyList: (id)propertyList
|
||||
{
|
||||
_NSSerializerInfo info;
|
||||
|
|
@ -377,6 +381,10 @@ static BOOL shouldBeCompact = NO;
|
|||
return info.data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts the supplied propertyList into a serialized representation
|
||||
* stored in d.
|
||||
*/
|
||||
+ (void) serializePropertyList: (id)propertyList
|
||||
intoData: (NSMutableData*)d
|
||||
{
|
||||
|
|
@ -822,6 +830,16 @@ deserializeFromInfo(_NSDeserializerInfo* info)
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>Deserializes the property list stored in data at the offset specified
|
||||
* by the value pointed to by cursor. Upon completion the value in cursor
|
||||
* is updated to refer to a position immediately after the end of the
|
||||
* deserialized sequence.
|
||||
* </p>
|
||||
* <p>The flag is used to specify whether container objects in the
|
||||
* deserialized list should be instances of mutable or immutable classes.
|
||||
* </p>
|
||||
*/
|
||||
+ (id) deserializePropertyListFromData: (NSData*)data
|
||||
atCursor: (unsigned int*)cursor
|
||||
mutableContainers: (BOOL)flag
|
||||
|
|
@ -846,6 +864,14 @@ deserializeFromInfo(_NSDeserializerInfo* info)
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>Deserializes the property list stored in data to produce a single
|
||||
* property list object (dictionary, array, string, data, number or date).
|
||||
* </p>
|
||||
* <p>The flag is used to specify whether container objects in the
|
||||
* deserialized list should be instances of mutable or immutable classes.
|
||||
* </p>
|
||||
*/
|
||||
+ (id) deserializePropertyListFromData: (NSData*)data
|
||||
mutableContainers: (BOOL)flag
|
||||
{
|
||||
|
|
@ -869,6 +895,21 @@ deserializeFromInfo(_NSDeserializerInfo* info)
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>Deserializes the property list stored in data at the offset specified
|
||||
* by the value pointed to by cursor. Upon completion the value in cursor
|
||||
* is updated to refer to a position immediately after the end of the
|
||||
* deserialized sequence.
|
||||
* </p>
|
||||
* <p>The flag is used to specify whether container objects in the
|
||||
* deserialized list should be instances of mutable or immutable classes.
|
||||
* </p>
|
||||
* <p>The length is used to determine whether lazy deserialization is done,
|
||||
* if the data is longer than this value, a proxy is returned rather than
|
||||
* the actual property list, and the real deserialization can be done
|
||||
* later.
|
||||
* </p>
|
||||
*/
|
||||
+ (id) deserializePropertyListLazilyFromData: (NSData*)data
|
||||
atCursor: (unsigned*)cursor
|
||||
length: (unsigned)length
|
||||
|
|
|
|||
Loading…
Reference in a new issue