From owner-freebsd-libh Mon Oct 29 11:48:37 2001 Delivered-To: freebsd-libh@freebsd.org Received: from tomts19-srv.bellnexxia.net (tomts19.bellnexxia.net [209.226.175.73]) by hub.freebsd.org (Postfix) with ESMTP id 2BB3A37B407 for ; Mon, 29 Oct 2001 11:48:27 -0800 (PST) Received: from khan.anarcat.dyndns.org ([65.94.136.15]) by tomts19-srv.bellnexxia.net (InterMail vM.4.01.03.16 201-229-121-116-20010115) with ESMTP id <20011029194825.UBFE4828.tomts19-srv.bellnexxia.net@khan.anarcat.dyndns.org> for ; Mon, 29 Oct 2001 14:48:25 -0500 Received: from shall.anarcat.dyndns.org (shall.anarcat.dyndns.org [192.168.0.1]) by khan.anarcat.dyndns.org (Postfix) with ESMTP id A23701A43 for ; Mon, 29 Oct 2001 14:48:36 -0500 (EST) Received: by shall.anarcat.dyndns.org (Postfix, from userid 1000) id 669C020ACE; Mon, 29 Oct 2001 14:49:24 -0500 (EST) Date: Mon, 29 Oct 2001 14:49:24 -0500 From: The Anarcat To: libh@FreeBSD.org Subject: Re: cvs commit: libh/doc/api gen_doc.pl Message-ID: <20011029144923.D94698@shall.anarcat.dyndns.org> References: <200110291934.f9TJYn774575@usw4.freebsd.org> <20011029144325.C94698@shall.anarcat.dyndns.org> Mime-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="8vCeF2GUdMpe9ZbK" Content-Disposition: inline In-Reply-To: <20011029144325.C94698@shall.anarcat.dyndns.org> User-Agent: Mutt/1.3.22.1i Sender: owner-freebsd-libh@FreeBSD.ORG Precedence: bulk List-ID: List-Archive: (Web Archive) List-Help: (List Instructions) List-Subscribe: List-Unsubscribe: X-Loop: FreeBSD.ORG --8vCeF2GUdMpe9ZbK Content-Type: multipart/mixed; boundary="tEFtbjk+mNEviIIX" Content-Disposition: inline --tEFtbjk+mNEviIIX Content-Type: text/plain; charset=us-ascii Content-Disposition: inline On Mon Oct 29, 2001 at 02:43:26PM -0500, The Anarcat wrote: > Now this thingie can produce docs such as the attached Disk > documentation. a. --tEFtbjk+mNEviIIX Content-Type: text/plain; charset=us-ascii Content-Disposition: attachment; filename="Disk.txt" +======------- |Member Disk::Disk open |Arguments: Value(MethodDescription::vtString, 0, 0, "devname") |returns "Disk": Object |Opens the named disk +======------- |Member Disk::open open |Arguments: Value(MethodDescription::vtString, 0, 0, "devname") |returns "Disk": Object |Opens the named disk +======------- |Member Disk::clone clone |Arguments: vtVoid |returns "Disk": Object |Clone a copy of a tree. Useful for \"Undo\" functionality +======------- |Member Disk::chunks chunks |Arguments: vtVoid |returns "DiskChunk": Object |Returns chunks head object +======------- |Member Disk::sector_size sector_size |Arguments: vtVoid |returns : ULong |Returns the disk sector size +======------- |Member Disk::debug debug |Arguments: vtVoid |returns : Void |Print the content of the tree to stdout +======------- |Member Disk::name name |Arguments: vtVoid |returns : String | +======------- |Member Disk::flags flags_names |Arguments: vtVoid |returns "Container >": ListPtr |The only flag value by now is DISK_ON_TRACK +======------- |Member Disk::bios_cyl bios_cyl |Arguments: vtVoid |returns : ULong | +======------- |Member Disk::bios_hd bios_hd |Arguments: vtVoid |returns : ULong | +======------- |Member Disk::bios_sect bios_sect |Arguments: vtVoid |returns : ULong | +======------- |Member Disk::modified modified |Arguments: vtVoid |returns : Bool |Returns if memory disk struture differs from written on disk +======------- |Member Disk::Disk_Names Disk_Names |Arguments: vtVoid |returns "Container >": ListPtr |Returns all disk's names (ad0 +======------- |Member Disk::standard_slice_types standard_slice_types |Arguments: vtVoid |returns "Container >": ListPtr |Returns list of known slice types names +======------- |Member Disk::standard_slice_type_id standard_slice_type_id |Arguments: Value(MethodDescription::vtString, 0, 0, "name") |returns : Int |Returns id of known slice type (by name) or 0 +======------- |Member Disk::slice_type_name slice_type_name |Arguments: Value(MethodDescription::vtInt, 0, 0, "slice_id") |returns : String |Returns slice type name by id +======------- |Member Disk::Delete_Chunk Delete_Chunk |Arguments: Value(MethodDescription::vtObject, "DiskChunk", 0, "chunk") |returns : Int |Returns 0 on success +======------- |Member Disk::Create_Chunk Create_Chunk |Arguments: vtULong |returns : Int |Creates a chunk with the specified paramters. Returns 0 on success +======------- |Member Disk::Create_Chunk_DWIM Create_Chunk_DWIM |Arguments: vtObject |returns "DiskChunk": Object |Creates a partition inside the given parent of the given size +======------- |Member Disk::All_FreeBSD All_FreeBSD |Arguments: Value(MethodDescription::vtBool, 0, 0, "force_all") |returns : Void |Make one FreeBSD chunk covering the entire disk; if force_all is set +======------- |Member Disk::Set_Bios_Geom Set_Bios_Geom |Arguments: vtULong |returns : Void |Set the geometry the bios uses. +======------- |Member Disk::undo undo |Arguments: vtVoid |returns : Void |Undo changes. +======------- |Member Disk::Write_Disk Write_Disk |Arguments: vtVoid |returns : Int |Write data to disk. +======------- |Member Disk::)};LanguageInterface::Object::CallbackDescription Disk::sCallbacks[] ={ CallbackDescription()};LanguageInterface::Object::ClassDescription Disk::sClassDescription( "Disk Disk |Arguments: vtVoid |returns : Long |sMethods +======------- |Member Disk::size size |Arguments: vtVoid |returns : ULong | +======------- |Member Disk::end end |Arguments: vtVoid |returns : ULong | +======------- |Member Disk::name name |Arguments: vtVoid |returns : String | +======------- |Member Disk::type type |Arguments: vtVoid |returns : Int |0 - whole +======------- |Member Disk::type_text type_text |Arguments: vtVoid |returns : String | +======------- |Member Disk::subtype subtype |Arguments: vtVoid |returns : Int | +======------- |Member Disk::slice_type_name slice_type_name |Arguments: vtVoid |returns : String | +======------- |Member Disk::flags flags_names |Arguments: Value(MethodDescription::vtList, "list", "get-or-set", "flags") |returns "Container >": ListPtr |CHUNK_BSD_COMPAT (in the BSD-compatibility +======------- |Member Disk::mountpoint mountpoint |Arguments: Value(MethodDescription::vtString, 0, "get-or-set", "mountpoint") |returns : String |Returns or sets partition mount point +======------- |Member Disk::newfs newfs |Arguments: Value(MethodDescription::vtInt, 0, "get-or-set", "newfs") |returns : Int |Returns or sets partition newfs flag: 0-no +======------- |Member Disk::newfs_cmd newfs_cmd |Arguments: Value(MethodDescription::vtString, 0, "get-or-set", "mountpoint") |returns : String |Returns or sets newfs command for the partition +======------- |Member Disk::is_fs is_fs |Arguments: vtVoid |returns : Bool |Returns if partition is allocated for FreeBSD filesystem +======------- |Member Disk::is_swap is_swap |Arguments: vtVoid |returns : Bool |Returns if partition is allocated for swap +======------- |Member Disk::part part |Arguments: vtVoid |returns "DiskChunk": Object |Partition chunk +======------- |Member Disk::next next |Arguments: vtVoid |returns "DiskChunk": Object |Next chunk +======------- |Member Disk::set_type set_type |Arguments: Value(MethodDescription::vtInt, 0, 0, "subtype") |returns : Void |Sets the slice subtype and type --tEFtbjk+mNEviIIX-- --8vCeF2GUdMpe9ZbK Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.0.6 (FreeBSD) Comment: For info see http://www.gnupg.org iEYEARECAAYFAjvdssMACgkQttcWHAnWiGeZtACeL4DZB9ICwxzawb3CORkBD4ZR FJEAniMICqlcZBeHwmK9Z6yPiq8S3Rmy =VbMu -----END PGP SIGNATURE----- --8vCeF2GUdMpe9ZbK-- To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-libh" in the body of the message