Commit Graph

15 Commits

Author SHA1 Message Date
Frank Baker
833a8db230 [svn-r2381] Added line to each HTML doc file noting release number.
In many cases, also updated "Last modified:" date.
2000-06-09 13:02:29 -05:00
Frank Baker
51d2cdb1d0 [svn-r2338] Updating structural cross-links within doc set. 2000-06-05 10:44:34 -05:00
Frank Baker
70e48f28e5 [svn-r2093] RM_H5D.html
H5Dclose: Corrected return type to herr_t (was hid_t).
	H5Dcreate: Inserted missing spaces in function syntax statement.
RM_H5E.html
	H5Ewalk: Added H5E_walk_t prototype and prototype parameter
	    descriptions.
RM_H5F.html
	H5Fclose: Corrected behavior description, eliminating
	    comment that function fials if other access identifiers
	    are still open and describing actual behavior.
RM_H5T.html
	H5Tget_class: Corrected H5T_ENUM and H5T_REFERENCE entries in
	        class identifiers table (they were reversed).
        H5Tregister:  Corrected possible 'pers' values to H5T_PERS_HARD
            (was HARD) and H5T_PERS_SOFT (was SOFT).
        H5Tfind: Corrected 'pcdata' parameter IN/OUT designation.
2000-04-07 14:46:47 -05:00
Frank Baker
79a3cec4bd [svn-r1907] RM_H5D.html H5Dopen: Corrected description of 'loc_id' parameter.
H5.intro.html   Added paragraph stating that changes in bugfix releases
	        are listed in the RELEASE, HISTORY, and README files.
1999-12-18 21:30:04 -05:00
Frank Baker
d0505ef917 [svn-r1888] RM_H5F.html H5Fcreate, H5Fopen: Clarified description of file access flags
in parameters section and removed reference to H5Fpublic.h.
RM_H5D.html    H5Dvlen_reclaim: Inserted missing punctuation.
	       H5Dcreate: Added paragraph explaining that 'name' must be unique.
1999-12-17 10:37:56 -05:00
Frank Baker
42f49894fc [svn-r1875]
HDF5 Reference Manual
	Backs out FORTRAN API info. (It was checked into wrong tree.)
	Retains minor edits and formatting fixes that were made while
	   inserting FORTRAN.
1999-12-14 09:45:34 -05:00
Frank Baker
c276782ca3 [svn-r1827] Added Fortran90 API functions for Release 1.2 Fortran90 prototype. 1999-11-04 10:32:11 -05:00
Frank Baker
7f885e42ac [svn-r1677] RM_H5P.html
Added 'Name' to H5Pget_core.
RM_H5D.html
	Added 'Purpose' to H5Dclose.
1999-09-27 20:58:26 -05:00
Frank Baker
8cffd507bf [svn-r1584] RM_H5D.html
Added H5DGet_storage_size and H5Diterate.
RM_H5F.html
	Rearranged TOC.
RM_H5P.html
	Added H5Pset/get_hyper_cache, H5Pset/get_btree_ratios, H5Pset/get_gc_references,
	and H5Pget_vlen_mem_manager.
RM_H5R.html
	Added H5Rget_object_type.
RM_H5Front.html
	As functions were added to the Reference Manual (above), they were
	removed from "functions missing in the RM" list in this document.
1999-08-23 15:31:25 -05:00
Frank Baker
b3491fd4d1 [svn-r1540] RM_H5D.html
Correct spelling error in H5Dget_vlen_buf_size.
1999-07-23 18:15:09 -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
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