Commit Graph

12 Commits

Author SHA1 Message Date
Frank Baker
2c3783004c [svn-r1720] RM_H5T.html
H5Tget_nmembers: Corrected return type.
	H5Tinsert_array: Explained that perm parameter is not yet
		implemented; value should currently be set to NULL.
	  Specified limits on value of ndims.
	  Slightly expanded description of offset.
1999-10-04 16:55:31 -05:00
Frank Baker
ab1a73dd3a [svn-r1673] RM_H5T.html
Added H5Tget_member_offset.
	Corrected H5Tinsert description to read that an element of a
		compound datatype can itself be a compound datatype.
	Font correction.
RM_H5F.html
RM_H5T.html
	Updated return value descriptions for H5Fis_hdf5, H5Tcommitted,
	and H5Tequal to correspond to the earlier hbool_t -> htri_t change.
1999-09-27 20:48:44 -05:00
Frank Baker
e8ea992779 [svn-r1601] RM_H5T.htm
Corrected return types for H5Tenum_valueof and H5Tenum_nameof.
1999-08-25 17:36:42 -05:00
Frank Baker
2addc89f28 [svn-r1600]
RM_H5T.html
	Deleted H5Tregister_hard and H5Tregister_soft.
	Added H5Tregister.
	In H5Tunregister, removed duplicate description of conversion
		function pointer type declaration, referring reader to
		H5Tregister.
	Added H5Tenum_create, H5Tenum_insert, H5Tenum_nameof, H5Tenum_valueof,
		H5Tget_member_value, H5Tgset/get_tag, and H5Tget_super.
	Restructured the linked list of functions at the top of the page to
		accommodate the new entries.
RM_H5Front.html
	Since these are the last of the missing functions, removed the
	list of functions missing from the RM.
1999-08-25 17:18:12 -05:00
Frank Baker
3229952348 [svn-r1570]
RM_H5F.html
RM_H5S.html
RM_H5T.html
Dataspaces.html
Datatypes.html
	Corrected return type (nbool_t to htri_t) for the functions
	H5Fis_hdf5, H5Sis_simple, H5Sselect_valid, H5Tcommitted, and H5Tequal.

RM_H5S.html
	Corrected h5s_selopt_t to H5S_selopt_t (3 places).
	Corrected description of H5Sget_select_npoints.
1999-08-13 14:39:29 -05:00
Frank Baker
b872c241d3 [svn-r1539]
Datatypes.html
VLdatatypes.html (temporary doc file)
RM_H5T.html
RM_H5D.html
	Adding variable-length datatype information to the user docs.
        VLdatatypes.html is a temporary file; it will be removed once
	all of the information is incorporated into Datatypes.html
	and the RM.
1999-07-23 18:08:41 -05:00
Frank Baker
2f3da042cf [svn-r1524]
RM_H5R.html
   H5Rget_region
	Removed "Not yet implemented" note.
	Corrected syntax to agree with description in H5R.c
	Added mention of valid 'ref_type' value; deleted reference to User's Guide.
   H5Rdereference
	Added list of valid 'ref_type' values; deleted reference to User's Guide.

RM_H5T.html
   H5Tget_class
	Added H5T_ENUM and H5T_REFERENCE to list of return values.
   H5Topen
	Corrected description of 'loc_id'; clarified description of 'name'.
   H5Tinsert
	Corrected 'offset' datatype.

RM_H5P.html
Datasets.html
   Fixed minor formatting errors.
   H5Pset_layout
   H5Pget_layout
	Added comment that H5D_COMPACT layout type is not yet implemented.
   H5Pset_external
	Added note regarding setting 'size' to H5F_UNLIMITED.
   H5Pset_family                                           (RM_H5P.html only)
	Removed extra function entry ('original version').
   H5Pget_split                                            (RM_H5P.html only)
	Corrected pair of typos in 'meta_ext' description.
1999-07-21 15:46:42 -05:00
Frank Baker
d70b72d630 [svn-r1425]
RM_H5S.html
Dataspaces.html
	H5Sselect_hyperslab
	H5Sselect_elements
	    Add H5S_SELECT_OR operator.
	    Converted operator list to a table.
	H5Sextent_copy
	    Corrected source and destination descriptions.  (RM_H5S.html only)
	H5Screate
	    Removed unused H5S_NONE dataspace type.
	H5Sset_extent_none
	    Corrected reset class type to H5S_NO_CLASS (previously said H5S_NONE).

RM_H5G.html
	H5Gget_linkval
	    Corrected descriptions of 'loc_id', 'name', and 'value'.
	    Corrected "Purpose".
	    Emphasized need to call H5Gget_objinfo first.
	H5Gset_comment
	H5Gget_comment
	    Corrected description of 'loc_id'.
	H5Gget_objinfo
	    Corrected description of 'loc_id'.
	    Added H5G_TYPE to list of valid values of 'type'.

RM_H5F.html
ExternalFiles.html
	H5Fmount
	H5Funmount
	    Corrected description of 'loc_id'.
	    Changed function descriptions in ExternalFiles.html to correspond to RM.

RM_H5T.html
	Moved H5Tget_class and H5Tget_size to "General Datatype Operations" in top index.
1999-07-06 11:56:15 -05:00
Frank Baker
82fb21b613 [svn-r985] Checking in changes from "HDF5 Release 1.0" CVS branch that have not yet
been checked into "HDF5 Development" branch.

General
=======
	Various "copy edit" types of repairs.
	Revisions to document cross-linking.
	Added structural links tying all docs together (banners
	   at top and bottom of documents, similar to Reference Manual
	   banners of the Beta release).
	Set background color to white in all documents.

NCSAfooterlogo.gif
hdf2.jpg
	New image files to make the documents more self-contained
	(i.e., to prevent loading images from NCSA and HDF home servers).

index.html
	Redesigned to isolate links external to the installation
	in a single location.


Intro to HDF5
=============
H5.intro.html
	Fixed banner linking Intro to other docs.
	Set all URLs to be relative within the distribution; nothing
	   points back to the HDF server.
	Updates to "Limits of the Current Release" and "Changes in
	   the Current Release."


HDF5 User's Guide
=================
	Changed several User Guide section titles such that all
	   sections that are primarily about a particular interface
	   are now titled in the format "The xxxxx Interface (H5x)".

H5.user.html
	Commented out links to developer docs since they are marked
	   in MANIFEST as not being for distribution in the release.
	Removed 2nd and 3rd indices from page.
	Changed "freeform" lists of sections (TOCs) to aligned tables.

Datatypes.html
	Removed the sentence "I'm deferring definition until later
	   since they're probably not as important as the other data
	   types." from Section 3.3, "Properties of Date and Time
	   Atomic Types."
	Added info regarding 'char' versus 'string' datatypes.  Added
	   as Section 3.7, "Character and String Datatype Issues."

References.html
	Commented out substantial material (at end of document) from
	   References planning document that is not appropriate for
 	   the User Guide but that is worth keeping around.

Groups.html
	Final edits from elimination of "current working group."


HDF5 Reference Manual
=====================
	Removed "Draft" from the <title>__</title> lines.

RM_H5Front.html
	Removed 2nd and 3rd indices from page.
	Changed "freeform" lists of sections (TOCs) to aligned tables.

RM_H5F.html
RM_H5P.html
	Add file mounting information.
1998-12-21 17:52:56 -05:00
Frank Baker
cd3b105997 [svn-r830] ======
Intro
======
H5.intro.html
	Major rewrite to Groups section.  New Example 7 (groups).
	Added TOC and requisite links.
	Numbered sections.
	Labelled figures and centered those that were not.
	Fixed table formatting.

===========
User Guide
===========
H5.user.html
	Linked in Chunking.html.
	Linked in References.html.
	Linked in DDL.html.

Chunking.html
        Minor edits.

DDL.html
References.html
	New documents.

Datatypes.html
	Added "R Reference" to base name description and
	   "H5T_STD_ROBJ -- Reference to an entire object
	   in a file" to list of datatype names.

Files.html
	H5Fflush
	   Added scope parameter.

Groups.html
	Removed references to "current working group."
	Removed H5Gpush, H5Gpop, and H5Gset functions.
        Removed note that H5Glink and H5Gunlink were not implemented.

=================
Reference Manual
=================
RM_*.html and Tools.html
	Updated Reference Manual internal cross-linking (the link
	   banner at the top and bottom of each page).
	Changed
		Returns SUCCEED (0) if successful;
		otherwise FAIL (-1).
	   to read
		Returns a non-negative value if successful;
		otherwise returns a negative value.
	   and several derived changes where circumstances differred
	   only slightly.
	Minor copy edits throughout.

RM_H5.html
	Corrected H5open "Purpose" statement.

RM_H5A.html
	Changed H5Aget_name return type to hssize_t.

RM_H5F.html
	H5Fflush
	   Added scope parameter.
        Added H5Freopen.

RM_H5Front.html
	Reordered listing of interfaces to alphabetical order (H5,
	   H5A, H5D, ...)
 	Added H5I, H5R, and H5RA.

RM_H5G.html
	H5Gopen
	   Edited "Description."
	H5Gget_objinfo
	   Added named datatype to list of valid values for loc_id.

RM_H5I.html  Identifier Interface
	New section.

RM_H5P.html
	Added H5Pset_fill_value and H5Pget_fill_value.
        Several minor copy edits.

RM_H5R.html  Reference Interface
	New section.

H5RA.html
	Essentially a new section.  It was in the tree previously,
	but it did not actually have content.

RM_H5S.html
	Changed H5Sget_select_npoints return type to hssize_t.

Tools.html
	Updated h5dump documentation.
1998-10-29 17:13:17 -05:00
Frank Baker
3672cb4c1c [svn-r693] Update for beta release. Complete CVS log messages can be found with
the versions of these files that are maintained in hdf5/doc/src/.
1998-09-11 11:00:43 -05:00
Frank Baker
c8e75d27b0 [svn-r503] HDF5 Reference Manual
Updated for Alpha2.
1998-07-14 23:51:50 -05:00