BaseSerializable

Kind of class:	interface
Inherits from:	none
Known subinterfaces:	Serializable
Version:	16 May 2005
Author:	Arthur Clemens
Classpath:	BaseSerializable
File last modified:	Friday, 17 June 2005, 01:14:41

► View source

▼ Hide source

/**
These classes demonstrate the use of inheriting doc comments. The Javadoc rules (see Sun's Javadoc reference on <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#inheritingcomments">Automatic Copying of Method Comments</a>) describe two ways how doc comments are inherited:
<ol>
    <li>Implicit inheriting - when a method overrides a method in a superclass, or implements a method from an interface, the comment written in the superclass/interface are transferred to the subclass.</li>
    <li>Explicit inheriting - using the {@code @inheritDoc} tag. This is useful when a comment is added to the existing superclass' method comment.</li>
</ol>
The "inheriting comments" rules also tell that links are added under "Overrides" when a method overrides a superclass method VisDoc <i>generates a subheading "Overrides" in the documentation for the overriding method, with a link to the method it is overriding, whether or not the comment is inherited</i>.
When a method implements an interface method, VisDoc <i>generates a subheading "Specified by" in the documentation for the overriding method, with a link to the method it is implementing. This happens whether or not the comment is inherited</i>.
@author Arthur Clemens
@version 16 May 2005
*/

interface BaseSerializable {

    /**
    BaseSerializable method comment. Once when I was six years old I saw a magnificent picture in a book, called True Stories from Nature, about the primeval forest. It was a picture of a boa constrictor in the act of swallowing an animal.
    @param inObject BaseSerializable param comment.
    @return BaseSerializable return comment.
    @example BaseSerializable field comment.
    */
    public function serialize (inObject:Object) : String;
}

These classes demonstrate the use of inheriting doc comments. The Javadoc rules (see Sun's Javadoc reference on Automatic Copying of Method Comments) describe two ways how doc comments are inherited:

Implicit inheriting - when a method overrides a method in a superclass, or implements a method from an interface, the comment written in the superclass/interface are transferred to the subclass.
Explicit inheriting - using the @inheritDoc tag. This is useful when a comment is added to the existing superclass' method comment.

The "inheriting comments" rules also tell that links are added under "Overrides" when a method overrides a superclass method VisDoc generates a subheading "Overrides" in the documentation for the overriding method, with a link to the method it is overriding, whether or not the comment is inherited.
When a method implements an interface method, VisDoc generates a subheading "Specified by" in the documentation for the overriding method, with a link to the method it is implementing. This happens whether or not the comment is inherited.

Summary

Instance methods

serialize (inObject:Object) : String
- BaseSerializable method comment.

Instance methods

serialize

function serialize (

inObject:Object) : String

BaseSerializable method comment. Once when I was six years old I saw a magnificent picture in a book, called True Stories from Nature, about the primeval forest. It was a picture of a boa constrictor in the act of swallowing an animal.