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
6ff669ade2 [svn-r2330] RM_H5Front.html -- Minor reformatting.
RM_H5A.html -- H5Aiterate: Changed function type to herr_t.
RM_H5F.html -- H5Freopen: Corrected description of file_id parameter.
	    Added comment about eventually closing returned identifier.
	    Added clarification that function cannot open closed files.
RM_H5T.html -- H5Tget_class:  Removed numbers from class identifiers list.
	    Added H5T_VLEN to class identifiers list.
2000-06-02 17:02:04 -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
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
48b014bc9a [svn-r1587]
RM_H5S.html
	Added H5Sget_select_hyper_nblocks, H5Sget_select_hyper_blocklist,
	H5Sget_select_elem_npoints, H5Sget_select_elem_pointlist, and
        H5Sget_select_bounds.
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-24 15:14:18 -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
91e75701b4 [svn-r1571]
RM_H5Front.html
	Added list of functions that are not yet documented in the
	Release 1.2 Beta Reference manual.
1999-08-13 15:07:02 -05:00
Frank Baker
62f0caf0a5 [svn-r1221] Fixed Bug #293
RM_H5Front.html
		"H5A Annotation" Interface corrected to "H5A Attribute" interface.
	RM_H5G.html
		H5Glink loc_id description corrected.
1999-04-26 17:16:42 -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
ca9639706e [svn-r769] H5.intro.html
Revised and extended hyperslab selection image.
	Added section "Selecting a union of hyperslabs."
IH_map*.gif  (6 new files)
	New images for "Intro to HDF5."
	As a composite, these replace H5.intro.datamap.gif.
H5.intro.datamap.gif
	Removed.  Replaced by the composite IH_map*.gif.

RM_H5RA.html  (new file)
RM_H5Front.html
Tools.html
Ragged.html
H5.user.html
	Changed all H5R functions to H5RA.
	Changed Ragged Array API references from H5R to H5RA.
	Changed links to RM_H5R.html to RM_H5RA.html.
RM_H5R.html
	Removed.  Replaced by RM_H5RA.html.
1998-10-20 22:33:19 -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
Robb Matzke
b5e2752ad6 [svn-r673] Changes since 19980908
----------------------

./COPYING
	Reformatted as text instead of C.  Removed zlib crew from the
	list of contributors since no zlib code is actually in the
	hdf5 library.

./INSTALL
./INSTALL.ascired
./MANIFEST
	Minor updates for Beta release including version number
	change.

./INSTALL_MAINT
	Added information about making a release.

./RELEASE
	Updated function list based on public header files.

./bin/checkposix
	Got rid of complaints about some obvious things.

./doc/html/H5.api.html
./doc/html/RM_H5F.html
./src/H5F.c
./src/H5Fpublic.h
./test/tfile.c
	Changed H5Fget_create_template() and H5Fget_access_template()
	to H5Fget_create_plist() and H5Fget_access_plist() since that
	conforms better to lots of other names.

./doc/html/Datatypes.html
./doc/html/ExternalFiles.html
./doc/html/Files.html
./doc/html/H5.api.html
./doc/html/H5.sample_code.html
./doc/html/RM_H5F.html
./doc/html/RM_H5Front.html
	Changed `template' to `property list', etc.

./doc/html/Ragged.html	   [NEW]
	Documentation for ragged arrays.

./src/H5Iprivate.h
./src/H5Ipublic.h
./src/H5I.c
	Changed the scope of some symbols to be more local.

./src/H5.c
./src/H5AC.c
./src/H5D.c
./src/H5E.c
./src/H5F.c
./src/H5Ffamily.c
./src/H5Fistore.c
./src/H5Flow.c
./src/H5Fsec2.c
./src/H5Fsplit.c
./src/H5Fstdio.c
./src/H5G.c
./src/H5Gnode.c
./src/H5HG.c
./src/H5I.c
./src/H5O.c
./src/H5Ocomp.c
./src/H5Odtype.c
./src/H5Oefl.c
./src/H5Omtime.c
./src/H5Oname.c
./src/H5P.c
./src/H5S.c
./src/H5Shyper.c
./src/H5Tbit.c
./src/H5Tconv.c
./src/H5V.c
./src/H5Z.c
./src/H5private.h
	Fixed some violations of our naming scheme by adding HD to the
	beginning of all Posix functions.
1998-09-08 14:15:44 -05:00
Frank Baker
c8e75d27b0 [svn-r503] HDF5 Reference Manual
Updated for Alpha2.
1998-07-14 23:51:50 -05:00