| Documentation Contents |
Generates HTML pages of API documentation from Java source files. This document contains Javadoc examples for Sun Solaris.
Reference Guide
@tag
)
-option
)
javadoc [ options ] [ packagenames ] [ sourcefilenames ] [ -subpackages
pkg1:pkg2:...] [ @argfiles ]
Arguments can be in any order. See processing of Source Files for details on how the Javadoc tool determines which "
.java
" files to process.
options
- Command-line options, as specified in this document. To see a typical use of javadoc options, see Real-World Example.
packagenames
- A series of names of packages, separated by spaces, such as
java.lang java.lang.reflect java.awt
. You must separately specify each package you want to document. Wildcards are not allowed; use -subpackages for recursion. The Javadoc tool uses-sourcepath
to look for these package names. See Example - Documenting One or More Packagessourcefilenames
- A series of source file names, separated by spaces, each of which can begin with a path and contain a wildcard such as asterisk (*). The Javadoc tool will process every file whose name ends with ".java", and whose name, when stripped of that suffix, is actually a legal class name (see Identifiers). Therefore, you can name files with dashes (such as
X-Buffer
), or other illegal characters, to prevent them from being documented. This is useful for test files and template files The path that precedes the source file name determines where javadoc will look for the file. (The Javadoc tool does not use-sourcepath
to look for these source file names.) Relative paths are relative to the current directory, so passing inButton.java
is identical to./Button.java
. A source file name with an absolute path and a wildcard, for example, is/home/src/java/awt/Graphics*.java
. See Example - Documenting One or More Classes. You can also mix packagenames and sourcefilenames, as in Example - Documenting Both Packages and Classes-subpackages
pkg1:pkg2:...- Generates documentation from source files in the specified packages and recursively in their subpackages. An alternative to supplying packagenames or sourcefilenames.
@argfiles
- One or more files that contain a list of Javadoc options, packagenames and sourcefilenames in any order. Wildcards (*) and
-J
options are not allowed in these files.
The Javadoc tool parses the declarations and documentation comments in a set of Java source files and produces a corresponding set of HTML pages describing (by default) the public and protected classes, nested classes (but not anonymous inner classes), interfaces, constructors, methods, and fields. You can use it to generate the API (Application Programming Interface) documentation or the implementation documentation for a set of source files.
You can run the Javadoc tool on entire packages, individual source files, or both. When documenting entire packages, you can either use
-subpackages
for traversing recursively down from a top-level directory, or pass in an explicit list of package names. When documenting individual source files, you pass in a list of source (.java
) filenames. Examples are given at the end of this document. How Javadoc processes source files is covered next.Processing of source files
The Javadoc tool processes files that end in "
.java
" plus other files described under Source Files. If you run the Javadoc tool by explicitly passing in individual source filenames, you can determine exactly which ".java
" files are processed. However, that is not how most developers want to work, as it is simpler to pass in package names. The Javadoc tool can be run three ways without explicitly specifying the source filenames. You can (1) pass in package names, (2) use-subpackages
, and (3) use wildcards with source filenames (*.java
). In these cases, the Javadoc tool processes a ".java
" file only if it fulfills all of the following requirements:
- Its name, after stripping off the "
.java
" suffix, is actually a legal class name (see Identifiers for legal characters)- Its directory path relative to the root of the source tree is actually a legal package name (after converting its separators to dots)
- Its package statement contains the legal package name (specified in the previous bullet)
Processing of links - During a run, the Javadoc tool automatically adds cross-reference links to package, class and member names that are being documented as part of that run. Links appear in several places:
- Declarations (return types, argument types, field types)
- "See Also" sections generated from
@see
tags- In-line text generated from
{@link}
tags- Exception names generated from
@throws
tags- "Specified by" links to members in interfaces and "Overrides" links to members in classes
- Summary tables listing packages, classes and members
- Package and class inheritance trees
- The index
You can add hyperlinks to existing text for classes not included on the command line (but generated separately) by way of the
-link
and-linkoffline
options.Other processing details - The Javadoc tool produces one complete document each time it is run; it cannot do incremental builds -- that is, it cannot modify or directly incorporate results from previous runs of the Javadoc tool. However, it can link to results from other runs, as just mentioned.
As implemented, the Javadoc tool requires and relies on the java compiler to do its job. The Javadoc tool calls part of
javac
to compile the declarations, ignoring the member implementation. It builds a rich internal representation of the classes, including the class hierarchy, and "use" relationships, then generates the HTML from that. The Javadoc tool also picks up user-supplied documentation from documentation comments in the source code.In fact, the Javadoc tool will run on
.java
source files that are pure stub files with no method bodies. This means you can write documentation comments and run the Javadoc tool in the earliest stages of design while creating the API, before writing the implementation.Relying on the compiler ensures that the HTML output corresponds exactly with the actual implementation, which may rely on implicit, rather than explicit, source code. For example, the Javadoc tool documents default constructors (section 8.6.7 of Java Language Specification) that are present in the
.class
files but not in the source code.In many cases, the Javadoc tool allows you to generate documentation for source files whose code is incomplete or erroneous. This is a benefit that enables you to generate documentation before all debugging and troubleshooting is done. For example, according to the Java Language Specification, a class that contains an abstract method should itself be declared abstract. The Javadoc tool does not check for this, and would proceed without a warning, whereas the javac compiler stops on this error. The Javadoc tool does do some primitive checking of doc comments. Use the DocCheck doclet to check the doc comments more thoroughly.
When the Javadoc tool builds its internal structure for the documentation, it loads all referenced classes. Because of this, the Javadoc tool must be able to find all referenced classes, whether bootstrap classes, extensions, or user classes. For more about this, see How Classes Are Found. Generally speaking, classes you create must either be loaded as an extension or in the Javadoc tool's class path.
Javadoc Doclets
You can customize the content and format of the Javadoc tool's output by using doclets. The Javadoc tool has a default "built-in" doclet, called the standard doclet, that generates HTML-formatted API documentation. You can modify or subclass the standard doclet, or write your own doclet to generate HTML, XML, MIF, RTF or whatever output format you'd like. Information about doclets and their use is at the following locations:
When a custom doclet is not specified with the -doclet command line option, the Javadoc tool will use the default standard doclet. The javadoc tool has several command line options that are available regardless of which doclet is being used. The standard doclet adds a supplementary set of command line options. Both sets of options are described below in the options section.
Related Documentation and Doclets
- Javadoc Enhancements for details about improvements added in Javadoc.
- Javadoc FAQ for answers to common questions, information about Javadoc-related tools, and workarounds for bugs.
- How to Write Doc Comments for Javadoc for more information about Sun conventions for writing documentation comments.
- Requirements for Writing API Specifications - Standard requirements used when writing the Java 2 Platform Specification. It can be useful whether you are writing API specifications in source file documentation comments or in other formats. It covers requirements for packages, classes, interfaces, fields and methods to satisfy testable assertions.
- Documentation Comment Specification - The original specification on documentation comments, Chapter 18, Documentation Comments, in the Java Language Specification, First Edition, by James Gosling, Bill Joy, and Guy Steele. (This chapter was removed from the second edition.)
- DocCheck Doclet - Checks doc comments in source files and generates a report listing the errors and irregularities it finds. It is part of the Sun Doc Check Utilities.
- MIF Doclet - Can automate the generation of API documentation in MIF, FrameMaker and PDF formats. MIF is Adobe FrameMaker's interchange format.
Terminology
The terms documentation comment, doc comment, main description, tag, block tag, and in-line tag are described at Documentation Comments. These other terms have specific meanings within the context of the Javadoc tool:
- generated document
- The document generated by the javadoc tool from the doc comments in Java source code. The default generated document is in HTML and is created by the standard doclet.
- name
- A name of a program element written in the Java Language -- that is, the name of a package, class, interface, field, constructor or method. A name can be fully-qualified, such as
java.lang.String.equals(java.lang.Object)
, or partially-qualified, such asequals(Object)
.- documented classes
- The classes and interfaces for which detailed documentation is generated during a javadoc run. To be documented, the source files must be available, their source filenames or package names must be passed into the javadoc command, and they must not be filtered out by their access modifier (public, protected, package-private or private). We also refer to these as the classes included in the javadoc output, or the included classes.
- included classes
- Classes and interfaces whose details are documented during a run of the Javadoc tool. Same as documented classes.
- excluded classes
- Classes and interfaces whose details are not documented during a run of the Javadoc tool.
- referenced classes
- The classes and interfaces that are explicitly referred to in the definition (implementation) or doc comments of the documented classes and interfaces. Examples of references include return type, parameter type, cast type, extended class, implemented interface, imported classes, classes used in method bodies, @see, {@link}, {@linkplain}, and {@inheritDoc} tags. (Notice this definition has changed since 1.3.) When the Javadoc tool is run, it should load into memory all of the referenced classes in javadoc's bootclasspath and classpath. (The Javadoc tool prints a "Class not found" warning for referenced classes not found.) The Javadoc tool can derive enough information from the .class files to determine their existence and the fully-qualified names of their members.
- external referenced classes
- The referenced classes whose documentation is not being generated during a javadoc run. In other words, these classes are not passed into the Javadoc tool on the command line. Links in the generated documentation to those classes are said to be external references or external links. For example, if you run the Javadoc tool on only the
java.awt
package, then any class injava.lang
, such asObject
, is an external referenced class. External referenced classes can be linked to using the-link
and-linkoffline
options. An important property of an external referenced class is that its source comments are normally not available to the Javadoc run. In this case, these comments cannot be inherited.
The Javadoc tool will generate output originating from four different types of "source" files: Java language source files for classes (
.java
), package comment files, overview comment files, and miscellaneous unprocessed files. This section also covers test files and template files that can also be in the source tree, but which you want to be sure not to document.Class Source Code Files
Each class or interface and its members can have their own documentation comments, contained in a
.java
file. For more details about these doc comments, see Documentation Comments.Package Comment Files
Each package can have its own documentation comment, contained in its own "source" file, that the Javadoc tool will merge into the package summary page that it generates. You typically include in this comment any documentation that applies to the entire package.
To create a package comment file, you have a choice of two files to place your comments:
package-info.java
- Can contain a package declaration, package annotations, package comments and Javadoc tags. This file is new in JDK 5.0, and is preferred over package.html.package.html
- Can contain only package comments and Javadoc tags, no package annotations.A package may have a single
package.html
file or a singlepackage-info.java
file but not both. Place either file in the package directory in the source tree along with your.java
files.
package-info.java
- This file can contain a package comment of the following structure -- the comment is placed before the package declaration:File:
java/applet/package-info.java
/** * Provides the classes necessary to create an * applet and the classes an applet uses * to communicate with its applet context. *
 * The applet framework involves two entities: * the applet and the applet context. * An applet is an embeddable window (see the * {@link java.awt.Panel} class) with a few extra * methods that the applet context can use to * initialize, start, and stop the applet. * * @since 1.0 * @see java.awt */ package java.lang.applet;Note that while the comment separators
/**
and/*
must be present, the leading asterisks on the intermediate lines can be omitted.
package.html
- This file can contain a package comment of the following structure -- the comment is placed in the
element:File:
java/applet/package.html
  Provides the classes necessary to create an applet and the classes an applet uses to communicate with its applet context.
 The applet framework involves two entities: the applet and the applet context. An applet is an embeddable window (see the {@link java.awt.Panel} class) with a few extra methods that the applet context can use to initialize, start, and stop the applet. @since 1.0 @see java.awt  Notice this is just a normal HTML file and does not include a package declaration. The content of the package comment file is written in HTML, like all other comments, with one exception: The documentation comment should not include the comment separators
/**
and*/
or leading asterisks. When writing the comment, you should make the first sentence a summary about the package, and not put a title or any other text between
and the first sentence. You can include package tags; as with any documentation comment, all block tags must appear after the main description. If you add a@see
tag in a package comment file, it must have a fully-qualified name. For more details, see the example ofpackage.html
.Processing of package comment file - When the Javadoc tool runs, it will automatically look for the package comment file; if found, the Javadoc tool does the following:
- Copies the comment for processing. (For
package.html
, copies all content between
and
HTML tags. You can include a
section to put a<title>
, source file copyright statement, or other information, but none of these will appear in the generated documentation.)- Processes any package tags that are present.
- Inserts the processed text at the bottom of the package summary page it generates, as shown in Package Summary.
- Copies the first sentence of the package comment to the top of the package summary page. It also adds the package name and this first sentence to the list of packages on the overview page, as shown in Overview Summary. The end-of-sentence is determined by the same rules used for the end of the first sentence of class and member main descriptions.
Overview Comment File
Each application or set of packages that you are documenting can have its own overview documentation comment, kept in its own "source" file, that the Javadoc tool will merge into the overview page that it generates. You typically include in this comment any documentation that applies to the entire application or set of packages.
To create an overview comment file, you can name the file anything you want, typically
overview.html
and place it anywhere, typically at the top level of the source tree. For example, if the source files for thejava.applet
package are contained in/home/user/src/java/applet
directory, you could create an overview comment file at/home/user/src/overview.html
.Notice you can have multiple overview comment files for the same set of source files, in case you want to run javadoc multiple times on different sets of packages. For example, you could run javadoc once with -private for internal documentation and again without that option for public documentation. In this case, you could describe the documentation as public or internal in the first sentence of each overview comment file.
The content of the overview comment file is one big documentation comment, written in HTML, like the package comment file described previously. See that description for details. To re-iterate, when writing the comment, you should make the first sentence a summary about the application or set of packages, and not put a title or any other text between

and the first sentence. You can include overview tags; as with any documentation comment, all tags except in-line tags, such as{@link}
, must appear after the main description. If you add a@see
tag, it must have a fully-qualified name.When you run the Javadoc tool, you specify the overview comment file name with the -overview option. The file is then processed similar to that of a package comment file.
- Copies all content between

and
tags for processing.- Processes any overview tags that are present.
- Inserts the processed text at the bottom of the overview page it generates, as shown in Overview Summary.
- Copies the first sentence of the overview comment to the top of the overview summary page.
Miscellaneous Unprocessed Files
You can also include in your source any miscellaneous files that you want the Javadoc tool to copy to the destination directory. These typically includes graphic files, example Java source (.java) and class (.class) files, and self-standing HTML files whose content would overwhelm the documentation comment of a normal Java source file.
To include unprocessed files, put them in a directory called
doc-files
which can be a subdirectory of any package directory that contains source files. You can have one such subdirectory for each package. You might include images, example code, source files, .class files, applets and HTML files. For example, if you want to include the image of a buttonbutton.gif
in thejava.awt.Button
class documentation, you place that file in the/home/user/src/java/awt/doc-files/
directory. Notice thedoc-files
directory should not be located at/home/user/src/java/doc-files
becausejava
is not a package -- that is, it does not directly contain any source files.All links to these unprocessed files must be hard-coded, because the Javadoc tool does not look at the files -- it simply copies the directory and all its contents to the destination. For example, the link in the
Button.java
doc comment might look like:/** * This button looks like this: *  */Test Files and Template Files
Some developers have indicated they want to store test files and templates files in the source tree near their corresponding source files. That is, they would like to put them in the same directory, or a subdirectory, of those source files.
If you run the Javadoc tool by explicitly passing in individual source filenames, you can deliberately omit test and templates files and prevent them from being processed. However, if you are passing in package names or wildcards, you need to follow certain rules to ensure these test files and templates files are not processed.
Test files differ from template files in that the former are legal, compilable source files, while the latter are not, but may end with ".java".
Test files - Often developers want to put compilable, runnable test files for a given package in the same directory as the source files for that package. But they want the test files to belong to a package other than the source file package, such as the unnamed package (so the test files have no package statement or a different package statement from the source). In this scenario, when the source is being documented by specifying its package name specified on the command line, the test files will cause warnings or errors. You need to put such test files in a subdirectory. For example, if you want to add test files for source files in
com.package1
, put them in a subdirectory that would be an invalid package name (because it contains a hyphen):com/package1/test-files/The test directory will be skipped by the Javadoc tool with no warnings.
If your test files contain doc comments, you can set up a separate run of the Javadoc tool to produce documentation of the test files by passing in their test source filenames with wildcards, such as
com/package1/test-files/*.java
.Templates for source files - Template files have names that often end in ".java" and are not compilable. If you have a template for a source file that you want to keep in the source directory, you can name it with a dash (such as
Buffer-Template.java
), or any other illegal Java character, to prevent it from being processed. This relies on the fact that the Javadoc tool will only process source files whose name, when stripped of the ".java" suffix, is actually a legal class name (see Identifiers).
By default, javadoc uses a standard doclet that generates HTML-formatted documentation. This doclet generates the following kinds of files (where each HTML "page" corresponds to a separate file). Note that javadoc generates files with two types of names: those named after classes/interfaces, and those that are not (such as
package-summary.html
). Files in the latter group contain hyphens to prevent filename conflicts with those in the former group.Basic Content Pages
- One class or interface page (classname
.html
) for each class or interface it is documenting.- One package page (
package-summary.html
) for each package it is documenting. The Javadoc tool will include any HTML text provided in a file namedpackage.html
orpackage-info.java
in the package directory of the source tree.- One overview page (
overview-summary.html
) for the entire set of packages. This is the front page of the generated document. The Javadoc tool will include any HTML text provided in a file specified with the-overview
option. Note that this file is created only if you pass into javadoc two or more package names. For further explanation, see HTML Frames.)
- One class hierarchy page for the entire set of packages (
overview-tree.html
). To view this, click on "Overview" in the navigation bar, then click on "Tree".- One class hierarchy page for each package (
package-tree.html
) To view this, go to a particular package, class or interface page; click "Tree" to display the hierarchy for that package.- One "use" page for each package (
package-use.html
) and a separate one for each class and interface (class-use/
classname.html
). This page describes what packages, classes, methods, constructors and fields use any part of the given class, interface or package. Given a class or interface A, its "use" page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.- A deprecated API page (
deprecated-list.html
) listing all deprecated names. (A deprecated name is not recommended for use, generally due to improvements, and a replacement name is usually given. Deprecated APIs may be removed in future implementations.)- A constant field values page (
constant-values.html
) for the values of static fields.- A serialized form page (
serialized-form.html
) for information about serializable and externalizable classes. Each such class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class comment. The standard doclet automatically generates a serialized form page: any class (public or non-public) that implements Serializable is included, along withreadObject
andwriteObject
methods, the fields that are serialized, and the doc comments from the@serial
,@serialField
, and@serialData
tags. Public serializable classes can be excluded by marking them (or their package) with@serial exclude
, and package-private serializable classes can be included by marking them (or their package) with@serial include
. As of 1.4, you can generate the complete serialized form for public and private classes by running javadoc without specifying the-private
option.- An index (
index-*.html
) of all class, interface, constructor, field and method names, alphabetically arranged. This is internationalized for Unicode and can be generated as a single file or as a separate file for each starting character (such as A-Z for English).
- A help page (
help-doc.html
) that describes the navigation bar and the above pages. You can provide your own custom help file to override the default using-helpfile
.- One index.html file which creates the HTML frames for display. This is the file you load to display the front page with frames. This file itself contains no text content.
- Several frame files (
*-frame.html
) containing lists of packages, classes and interfaces, used when HTML frames are being displayed.- A package list file (
package-list
), used by the-link
and-linkoffline
options. This is a text file, not HTML, and is not reachable through any links.- A style sheet file (
stylesheet.css
) that controls a limited amount of color, font family, font size, font style and positioning on the generated pages.- A doc-files directory that holds any image, example, source code or other files that you want copied to the destination directory. These files are not processed by the Javadoc tool in any manner -- that is, any javadoc tags in them will be ignored. This directory is not generated unless it exists in the source tree.
The Javadoc tool will generate either two or three HTML frames, as shown in the figure below. It creates the minimum necessary number of frames by omitting the list of packages if there is only one package (or no packages). That is, when you pass a single package name or source files (*.java) belonging to a single package as arguments into the javadoc command, it will create only one frame (C) in the left-hand column -- the list of classes. When you pass into javadoc two or more package names, it creates a third frame (P) listing all packages, as well as an overview page (Detail). This overview page has the filename
overview-summary.html
. Thus, this file is created only if you pass in two or more package names. You can bypass frames by clicking on the "No Frames" link or entering at overview-summary.html.If you are unfamiliar with HTML frames, you should be aware that frames can have focus for printing and scrolling. To give a frame focus, click on it. Then on many browsers the arrow keys and page keys will scroll that frame, and the print menu command will print it.
------------ ------------ |C| Detail | |P| Detail | | | | | | | | | | |-| | | | | |C| | | | | | | | | | | | | | ------------ ------------ javadoc *.java javadoc java.lang java.awtLoad one of the following two files as the starting page depending on whether you want HTML frames or not:
index.html
(for frames)overview-summary.html
(for no frames)The generated class and interface files are organized in the same directory hierarchy that Java source files and class files are organized. This structure is one directory per subpackage.
For example, the document generated for the class
java.applet.Applet
class would be located atjava/applet/Applet.html
. The file structure for the java.applet package follows, given that the destination directory is namedapidocs
. All files that contain the word "frame" appear in the upper-left or lower-left frames, as noted. All other HTML files appear in the right-hand frame.NOTE - Directories are shown in bold. The asterisks (
*
) indicate the files and directories that are omitted when the arguments to javadoc are source filenames (*.java) rather than package names. Also when arguments are source filenames,package-list
is created but is empty. The doc-files directory will not be created in the destination unless it exists in the source tree.apidocs Top directory index.html Initial page that sets up HTML frames * overview-summary.html Lists all packages with first sentence summaries overview-tree.html Lists class hierarchy for all packages deprecated-list.html Lists deprecated API for all packages constant-values.html Lists values of static fields for all packages serialized-form.html Lists serialized form for all packages * overview-frame.html Lists all packages, used in upper-left frame allclasses-frame.html Lists all classes for all packages, used in lower-left frame help-doc.html Lists user help for how these pages are organized index-all.html Default index created without -splitindex option index-files Directory created with -splitindex option index-<number>.html Index files created with -splitindex option package-list Lists package names, used only for resolving external refs stylesheet.css HTML style sheet for defining fonts, colors and positions java Package directory applet Subpackage directory Applet.html Page for Applet class AppletContext.html Page for AppletContext interface AppletStub.html Page for AppletStub interface AudioClip.html Page for AudioClip interface * package-summary.html Lists classes with first sentence summaries for this package * package-frame.html Lists classes in this package, used in lower left-hand frame * package-tree.html Lists class hierarchy for this package package-use Lists where this package is used doc-files Directory holding image and example files class-use Directory holding pages API is used Applet.html Page for uses of Applet class AppletContext.html Page for uses of AppletContext interface AppletStub.html Page for uses of AppletStub interface AudioClip.html Page for uses of AudioClip interface src-html Source code directory java Package directory applet Subpackage directory Applet.html Page for Applet source code AppletContext.html Page for AppletContext source code AppletStub.html Page for AppletStub source code AudioClip.html Page for AudioClip source codeGenerated API Declarations
The Javadoc tool generates a declaration at the start of each class, interface, field, constructor, and method description for that API item. For example, the declaration for the
Boolean
class is:
public final class Boolean
extends Object
implements Serializableand the declaration for the
Boolean.valueOf
method is:
public static Boolean valueOf(String s)
The Javadoc tool can include the modifiers
public
,protected
,private
,abstract
,final
,static
,transient
, andvolatile
, but notsynchronized
ornative
. These last two modifiers are considered implementation detail and not part of the API specification.Rather than relying on the keyword
synchronized
, APIs should document their concurrency semantics in the comment's main description, as in "a singleEnumeration
cannot be used by multiple threads concurrently". The document should not describe how to achieve these semantics. As another example, whileHashtable
should be thread-safe, there's no reason to specify that we achieve this by synchronizing all of its exported methods. We should reserve the right to synchronize internally at the bucket level, thus offering higher concurrency.
The original "Documentation Comment Specification" can be found under related documentation.
Commenting the Source Code
You can include documentation comments ("doc comments") in the source code, ahead of declarations for any class, interface, method, constructor, or field. You can also create doc comments for each package and another one for the overview, though their syntax is slightly different. Doc comments are also known informally as "Javadoc comments" (but this term violates its trademark usage). A doc comment consists of the characters between the characters
/**
that begin the comment and the characters*/
that end it. Leading asterisks are allowed on each line and are described further below. The text in a comment can continue onto multiple lines./** * This is the typical format of a simple documentation comment * that spans two lines. */To save space you can put a comment on one line:
/** This comment takes up only one line. */Placement of comments - Documentation comments are recognized only when placed immediately before class, interface, constructor, method, or field declarations -- see the class example, method example, and field example. Documentation comments placed in the body of a method are ignored. Only one documentation comment per declaration statement is recognized by the Javadoc tool.
A common mistake is to put an
import
statement between the class comment and the class declaration. Avoid this, as the Javadoc tool will ignore the class comment./** * This is the class comment for the class Whatever. */ import com.sun; // MISTAKE - Important not to put import statement here public class Whatever { }A doc comment is composed of a main description followed by a tag section - The main description begins after the starting delimiter
/**
and continues until the tag section. The tag section starts with the first block tag, which is defined by the first@
character that begins a line (ignoring leading asterisks, white space, and leading separator/**
). It is possible to have a comment with only a tag section and no main description. The main description cannot continue after the tag section begins. The argument to a tag can span multiple lines. There can be any number of tags -- some types of tags can be repeated while others cannot. For example, this@see
starts the tag section:/** * This sentence would hold the main description for this doc comment. * @see java.lang.Object */Block tags and in-line tags - A tag is a special keyword within a doc comment that the Javadoc tool can process. There are two kinds of tags: block tags, which appear as
@tag
(also known as "standalone tags"), and in-line tags, which appear within curly braces, as{@tag}
. To be interpreted, a block tag must appear at the beginning of a line, ignoring leading asterisks, white space, and separator (/**
). This means you can use the@
character elsewhere in the text and it will not be interpreted as the start of a tag. If you want to start a line with the@
character and not have it be interpreted, use the HTML entity@
. Each block tag has associated text, which includes any text following the tag up to, but not including, either the next tag, or the end of the doc comment. This associated text can span multiple lines. An in-line tag is allowed and interpreted anywhere that text is allowed. The following example contains the block tag@deprecated
and in-line tag{@link}
./** * @deprecated As of JDK 1.1, replaced by {@link #setBounds(int,int,int,int)} */Comments are written in HTML - The text must be written in HTML, in that they should use HTML entities and can use HTML tags. You can use whichever version of HTML your browser supports; we have written the standard doclet to generate HTML 3.2-compliant code elsewhere (outside of the documentation comments) with the inclusion of cascading style sheets and frames. (We preface each generated file with "HTML 4.0" because of the frame sets.)
For example, entities for the less-than (
<
) and greater-than (>
) symbols should be written<
and>
. Likewise, the ampersand (&
) should be written&
. The bold HTML tag
is shown in the following example.Here is a doc comment:
/** * This is a doc comment. * @see java.lang.Object */Leading asterisks - When javadoc parses a doc comment, leading asterisk (
*
) characters on each line are discarded; blanks and tabs preceding the initial asterisk (*
) characters are also discarded. Starting with 1.4, if you omit the leading asterisk on a line, the leading white space is no longer removed. This enables you to paste code examples directly into a doc comment inside a

tag, and its indentation will be honored. Spaces are generally interpreted by browsers more uniformly than tabs. Indentation is relative to the left margin (rather than the separator/**
or

tag).First sentence - The first sentence of each doc comment should be a summary sentence, containing a concise but complete description of the declared entity. This sentence ends at the first period that is followed by a blank, tab, or line terminator, or at the first block tag. The Javadoc tool copies this first sentence to the member summary at the top of the HTML page.
Declaration with multiple fields - Java allows declaring multiple fields in a single statement, but this statement can have only one documentation comment, which is copied for all fields. Therefore if you want individual documentation comments for each field, you must declare each field in a separate statement. For example, the following documentation comment doesn't make sense written as a single declaration and would be better handled as two declarations:
/** * The horizontal and vertical distances of point (x,y) */ public int x, y; // Avoid thisThe Javadoc tool generates the following documentation from the above code:
public int x
- The horizontal and vertical distances of point (x,y)
public int y
- The horizontal and vertical distances of point (x,y)
Use header tags carefully - When writing documentation comments for members, it's best not to use HTML heading tags such as
 and
, because the Javadoc tool creates an entire structured document and these structural tags might interfere with the formatting of the generated document. However, it is fine to use these headings in class and package comments to provide your own structure.
Automatic Copying of Method Comments
The Javadoc tool has the ability to copy or "inherit" method comments in classes and interfaces under the following two circumstances. Constructors, fields and nested classes do not inherit doc comments.
- Automatically inherit comment to fill in missing text - When a main description, or
@return
,@param
or@throws
tag is missing from a method comment, the Javadoc tool copies the corresponding main description or tag comment from the method it overrides or implements (if any), according to the algorithm below.More specifically, when a
@param
tag for a particular parameter is missing, then the comment for that parameter is copied from the method further up the inheritance hierarchy. When a@throws
tag for a particular exception is missing, the@throws
tag is copied only if that exception is declared.This behavior contrasts with version 1.3 and earlier, where the presence of any main description or tag would prevent all comments from being inherited.
- Explicitly inherit comment with {@inheritDoc} tag - Insert the inline tag
{@inheritDoc}
in a method main description or@return
,@param
or@throws
tag comment -- the corresponding inherited main description or tag comment is copied into that spot.The source file for the inherited method need only be on the path specified by -sourcepath for the doc comment to actually be available to copy. Neither the class nor its package needs to be passed in on the command line. This contrasts with 1.3.x and earlier releases, where the class had to be a documented class
Inherit from classes and interfaces - Inheriting of comments occurs in all three possible cases of inheritance from classes and interfaces:
- When a method in a class overrides a method in a superclass
- When a method in an interface overrides a method in a superinterface
- When a method in a class implements a method in an interface
In the first two cases, for method overrides, the Javadoc tool 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.
In the third case, when a method in a given class implements a method in an interface, the Javadoc tool 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.
Algorithm for Inheriting Method Comments - If a method does not have a doc comment, or has an {@inheritDoc} tag, the Javadoc tool searches for an applicable comment using the following algorithm, which is designed to find the most specific applicable doc comment, giving preference to interfaces over superclasses:
- Look in each directly implemented (or extended) interface in the order they appear following the word implements (or extends) in the method declaration. Use the first doc comment found for this method.
- If step 1 failed to find a doc comment, recursively apply this entire algorithm to each directly implemented (or extended) interface, in the same order they were examined in step 1.
- If step 2 failed to find a doc comment and this is a class other than Object (not an interface):
- If the superclass has a doc comment for this method, use it.
- If step 3a failed to find a doc comment, recursively apply this entire algorithm to the superclass.
The Javadoc tool parses special tags when they are embedded within a Java doc comment. These doc tags enable you to autogenerate a complete, well-formatted API from your source code. The tags start with an "at" sign (
@
) and are case-sensitive -- they must be typed with the uppercase and lowercase letters as shown. A tag must start at the beginning of a line (after any leading spaces and an optional asterisk) or it is treated as normal text. By convention, tags with the same name are grouped together. For example, put all@see
tags together.
- Block tags - Can be placed only in the tag section that follows the main description. Block tags are of the form:
@tag
.- Inline tags - Can be placed anywhere in the main description or in the comments for block tags. Inline tags are denoted by curly braces:
{@tag}
.For information about tags we might introduce in future releases, see Proposed Tags.
The current tags are:
Tag Introduced in JDK/SDK @author
1.0 {@code}
1.5 {@docRoot}
1.3 @deprecated
1.0 @exception
1.0 {@inheritDoc}
1.4 {@link}
1.2 {@linkplain}
1.4 {@literal}
1.5 @param
1.0 @return
1.0 @see
1.0 @serial
1.2 @serialData
1.2 @serialField
1.2 @since
1.1 @throws
1.2 {@value}
1.4 @version
1.0 For custom tags, see the -tag option.
@author
name-text- Adds an "Author" entry with the specified name-text to the generated docs when the -author option is used. A doc comment may contain multiple
@author
tags. You can specify one name per@author
tag or multiple names per tag. In the former case, the Javadoc tool inserts a comma (,
) and space between names. In the latter case, the entire text is simply copied to the generated document without being parsed. Therefore, you can use multiple names per line if you want a localized name separator other than comma.For more details, see Where Tags Can Be Used and writing @author tags.
@deprecated
deprecated-textNote: Starting with JDK 5.0, you can deprecate a program element using the @Deprecated annotation.
Adds a comment indicating that this API should no longer be used (even though it may continue to work). The Javadoc tool moves the deprecated-text ahead of the main description, placing it in italics and preceding it with a bold warning: "Deprecated". This tag is valid in all doc comments: overview, package, class, interface, constructor, method and field.
The first sentence of deprecated-text should at least tell the user when the API was deprecated and what to use as a replacement. The Javadoc tool copies just the first sentence to the summary section and index. Subsequent sentences can also explain why it has been deprecated. You should include a
{@link}
tag (for Javadoc 1.2 or later) that points to the replacement API:For more details, see writing @deprecated tags.
- For Javadoc 1.2 and later, use a
{@link}
tag. This creates the link in-line, where you want it. For example:/** * @deprecated As of JDK 1.1, replaced by {@link #setBounds(int,int,int,int)} */
- For Javadoc 1.1, the standard format is to create a
@see
tag (which cannot be in-line) for each@deprecated
tag.For more about deprecation, see The @deprecated tag.
{@code
text}
- Equivalent to
{@literal}
.Displays text in
code
font without interpreting the text as HTML markup or nested javadoc tags. This enables you to use regular angle brackets (<
and>
) instead of the HTML entities (<
and>
) in doc comments, such as in parameter types (<Object>
), inequalities (3 < 4
), or arrows (<-
). For example, the doc comment text:{@code AC}
displays in the generated HTML page unchanged, as:
AC
The noteworthy point is that the

is not interpreted as bold and is in code font.If you want the same functionality without the code font, use
{@literal}
.
{@docRoot}
- Represents the relative path to the generated document's (destination) root directory from any generated page. It is useful when you want to include a file, such as a copyright page or company logo, that you want to reference from all generated pages. Linking to the copyright page from the bottom of each page is common.
This
{@docRoot}
tag can be used both on the command line and in a doc comment: This tag is valid in all doc comments: overview, package, class, interface, constructor, method and field, including the text portion of any tag (such as @return, @param and @deprecated).
- On the command line, where the header/footer/bottom are defined:
javadoc -bottom '<a<EMAIL_ADDRESS>- When using
{@docRoot}
this way in a make file, some makefile programs require special escaping for the brace {} characters. For example, the Inprise MAKE version 5.2 running on Windows requires double braces:{{@docRoot}}
. It also requires double (rather than single) quotes to enclose arguments to options such as-bottom
(with the quotes around thehref
argument omitted).- In a doc comment:
/** * See the <a<EMAIL_ADDRESS>*/The reason this tag is needed is because the generated docs are in hierarchical directories, as deep as the number of subpackages. This expression:
<a<EMAIL_ADDRESS>resolve to:
 for java/lang/Object.javaand
 for java/lang/ref/Reference.java
@exception
class-name description- The
@exception
tag is a synonym for@throws
.
{@inheritDoc}
- Inherits (copies) documentation from the "nearest" inheritable class or implementable interface into the current doc comment at this tag's location. This allows you to write more general comments higher up the inheritance tree, and to write around the copied text.
This tag is valid only in these places in a doc comment:
- In the main description block of a method. In this case, the main description is copied from a class or interface up the hierarchy.
- In the text arguments of the @return, @param and @throws tags of a method. In this case, the tag text is copied from the corresponding tag up the hierarchy.
See Automatic Copying of Method Comments for a more precise description of how comments are found in the inheritance hierarchy. Note that if this tag is missing, the comment is or is not automatically inherited according to rules described in that section.
{@link
package.class#
member label}
- Inserts an in-line link with visible text label that points to the documentation for the specified package, class or member name of a referenced class. This tag is valid in all doc comments: overview, package, class, interface, constructor, method and field, including the text portion of any tag (such as @return, @param and @deprecated).
This tag is very simliar to
@see
-- both require the same references and accept exactly the same syntax for package.class#
member and label. The main difference is that{@link}
generates an in-line link rather than placing the link in the "See Also" section. Also, the{@link}
tag begins and ends with curly braces to separate it from the rest of the in-line text. If you need to use "}" inside the label, use the HTML entity notation }There is no limit to the number of
{@link}
tags allowed in a sentence. You can use this tag in the main description part of any documentation comment or in the text portion of any tag (such as @deprecated, @return or @param).For example, here is a comment that refers to the
getComponentAt(int, int)
method:Use the {@link #getComponentAt(int, int) getComponentAt} method.From this, the standard doclet would generate the following HTML (assuming it refers to another class in the same package):
Use the getComponentAt method.Which appears on the web page as:
Use the getComponentAt method.You can extend
{@link}
to link to classes not being documented by using the-link
option.For more details, see writing {@link} tags.
{@linkplain
package.class#
member label}
- Identical to
{@link}
, except the link's label is displayed in plain text than code font. Useful when the label is plain text. Example:Refer to {@linkplain add() the overridden method}.This would display as:
Refer to the overridden method.
{@literal
text}
- Displays text without interpreting the text as HTML markup or nested javadoc tags. This enables you to use regular angle brackets (
<
and>
) instead of the HTML entities (<
and>
) in doc comments, such as in parameter types (<Object>
), inequalities (3 < 4
), or arrows (<-
). For example, the doc comment text:{@literal AC}
displays unchanged in the generated HTML page in your browser, as:
AC
The noteworthy point is that the

is not interpreted as bold (and it is not in code font).If you want the same functionality but with the text in code font, use
{@code}
.
@param
parameter-name description- Adds a parameter with the specified parameter-name followed by the specified description to the "Parameters" section. When writing the doc comment, you may continue the description onto multiple lines. This tag is valid only in a doc comment for a method, constructor or class.
The parameter-name can be the name of a parameter in a method or constructor, or the name of a type parameter of a class, method or constructor. Use angle brackets around this parameter name to specify the use of a type parameter.
Example of a type parameter of a class:
/** * @param <E> Type of element stored in a list */ public interface List<E> extends Collection<E> { }Example of a type parameter of a method:
/** * @param string the string to be converted * @param type the type to convert the string to * @param <T> the type of the element * @param <V> the value of the element */ <T, V extends T> V convert(String string, Class<T> type) { }For more details, see writing @param tags.
@return
description- Adds a "Returns" section with the description text. This text should describe the return type and permissible range of values. This tag is valid only in a doc comment for a method.
For more details, see writing @return tags.
@see
reference- Adds a "See Also" heading with a link or text entry that points to reference. A doc comment may contain any number of
@see
tags, which are all grouped under the same heading. The@see
tag has three variations; the third form below is the most common. This tag is valid in any doc comment: overview, package, class, interface, constructor, method or field. For inserting an in-line link within a sentence to a package, class or member, see{@link}
.
@see
"
string"- Adds a text entry for string. No link is generated. The string is a book or other reference to information not available by URL. The Javadoc tool distinguishes this from the previous cases by looking for a double-quote (
"
) as the first character. For example:@see "The Java Programming Language"This generates text such as:
- See Also:
- "The Java Programming Language"
@see

label
- Adds a link as defined by URL#value. The URL#value is a relative or absolute URL. The Javadoc tool distinguishes this from other cases by looking for a less-than symbol (
<
) as the first character. For example:@see Java SpecThis generates a link such as:
- See Also:
- Java Spec
@see
package.class#
member label- Adds a link, with visible text label, that points to the documentation for the specified name in the Java Language that is referenced. The label is optional; if omitted, the name appears instead as the visible text, suitably shortened -- see How a name is displayed. Use -noqualifier to globally remove the package name from this visible text. Use the label when you want the visible text to be different from the auto-generated visible text.
Only in version 1.2, just the name but not the label would automatically appear in  HTML tags, Starting with 1.2.2, the  is always included around the visible text, whether or not a label is used.
- package.class
#
member is any valid program element name that is referenced -- a package, class, interface, constructor, method or field name -- except that the character ahead of the member name should be a hash character (#
). The class represents any top-level or nested class or interface. The member represents any constructor, method or field (not a nested class or interface). If this name is in the documented classes, the Javadoc tool will automatically create a link to it. To create links to external referenced classes, use the-link
option. Use either of the other two@see
forms for referring to documentation of a name that does not belong to a referenced class. This argument is described at greater length below under Specifying a Name.- label is optional text that is visible as the link's label. The label can contain whitespace. If label is omitted, then package.class.member will appear, suitably shortened relative to the current class and package -- see How a name is displayed.
- A space is the delimiter between package.class
#
member and label. A space inside parentheses does not indicate the start of a label, so spaces may be used between parameters in a method.Example - In this example, an
@see
tag (in theCharacter
class) refers to theequals
method in theString
class. The tag includes both arguments: the name "String#equals(Object)
" and the label "equals
"./** * @see String#equals(Object) equals */The standard doclet produces HTML something like this:

See Also:
equals
Which looks something like this in a browser, where the label is the visible link text:
- See Also:
- equals
Specifying a name - This package.class
#
member name can be either fully-qualified, such asjava.lang.String#toUpperCase()
or not, such asString#toUpperCase()
or#toUpperCase()
. If less than fully-qualified, the Javadoc tool uses the normal Java compiler search order to find it, further described below in Search order for @see. The name can contain whitespace within parentheses, such as between method arguments.Of course the advantage of providing shorter, "partially-qualified" names is that they are shorter to type and there is less clutter in the source code. The following table shows the different forms of the name, where Class can be a class or interface, Type can be a class, interface, array, or primitive, and method can be a method or constructor.
Typical forms for @see
package.class#memberReferencing a member of the current class
@see
#
field
@see
#
method(Type, Type,...)
@see
#
method(Type argname, Type argname,...)
@see
#
constructor(Type, Type,...)
@see
#
constructor(Type argname, Type argname,...)Referencing another class in the current or imported packages
@see
Class#
field
@see
Class#
method(Type, Type,...)
@see
Class#
method(Type argname, Type argname,...)
@see
Class#
constructor(Type, Type,...)
@see
Class#
constructor(Type argname, Type argname,...)
@see
Class.NestedClass
@see
ClassReferencing an element in another package (fully qualified)
@see
package.Class#
field
@see
package.Class#
method(Type, Type,...)
@see
package.Class#
method(Type argname, Type argname,...)
@see
package.Class#
constructor(Type, Type,...)
@see
package.Class#
constructor(Type argname, Type argname,...)
@see
package.Class.NestedClass
@see
package.Class
@see
packageThe following notes apply to the above table:
- The first set of forms (with no class or package) will cause the Javadoc tool to search only through the current class's hierarchy. It will find a member of the current class or interface, one of its superclasses or superinterfaces, or one of its enclosing classes or interfaces (search steps 1-3). It will not search the rest of the current package or other packages (search steps 4-5).
- If any method or constructor is entered as a name with no parentheses, such as
getValue
, and if there is no field with the same name, the Javadoc tool will correctly create a link to it, but will print a warning message reminding you to add the parentheses and arguments. If this method is overloaded, the Javadoc tool will link to the first method its search encounters, which is unspecified.- Nested classes must be specified as outer
.
inner, not simply inner, for all forms.- As stated, the hash character (
#
), rather than a dot (.
) separates a member from its class. This enables the Javadoc tool to resolve ambiguities, since the dot also separates classes, nested classes, packages, and subpackages. However, the Javadoc tool is generally lenient and will properly parse a dot if you know there is no ambiguity, though it will print a warning.Search order for @see - the Javadoc tool will process a
@see
tag that appears in a source file (.java), package file (package.html or package-info.java) or overview file (overview.html). In the latter two files, you must fully-qualify the name you supply with@see
. In a source file, you can specify a name that is fully-qualified or partially-qualified.When the Javadoc tool encounters a
@see
tag in a.java
file that is not fully qualified, it searches for the specified name in the same order as the Java compiler would (except the Javadoc tool will not detect certain namespace ambiguities, since it assumes the source code is free of these errors). This search order is formally defined in Chapter 6, "Names" of the Java Language Specification, Second Edition. The Javadoc tool searches for that name through all related and imported classes and packages. In particular, it searches in this order:
- the current class or interface
- any enclosing classes and interfaces, searching closest first
- any superclasses and superinterfaces, searching closest first
- the current package
- any imported packages, classes and interfaces, searching in the order of the import statement
The Javadoc tool continues to search recursively through steps 1-3 for each class it encounters until it finds a match. That is, after it searches through the current class and its enclosing class E, it will search through E's superclasses before E's enclosing classes. In steps 4 and 5, the Javadoc tool does not search classes or interfaces within a package in any specified order (that order depends on the particular compiler). In step 5, the Javadoc tool looks in java.lang, since that is automatically imported by all programs.
The Javadoc tool does not necessarily look in subclasses, nor will it look in other packages even if their documentation is being generated in the same run. For example, if the
@see
tag is in thejava.awt.event.KeyEvent
class and refers to a name in thejava.awt
package, javadoc does not look in that package unless that class imports it.How a name is displayed - If label is omitted, then package.class.member appears. In general, it is suitably shortened relative to the current class and package. By "shortened", we mean the Javadoc tool displays only the minimum name necessary. For example, if the
String.toUpperCase()
method contains references to a member of the same class and to a member of a different class, the class name is displayed only in the latter case, as shown in the following table.Use -noqualifier to globally remove the package names.
Type of Reference Example in String.toUpperCase()
Displays As @see
tag refers to member of the same class, same package@see String#toLowerCase()
toLowerCase()
(omits the package and class names)@see
tag refers to member of a different class, same package@see Character#toLowerCase(char)
Character.toLowerCase(char)
(omits the package name, includes the class name)@see
tag refers to member of a different class, different package@see java.io.File#exists()
java.io.File.exists()
(includes the package and class names)Examples of @see
The comment to the right shows how the name would be displayed if the@see
tag is in a class in another package, such asjava.applet.Applet
.See also: @see java.lang.String // String @see java.lang.String The String class // The String class @see String // String @see String#equals(Object) // String.equals(Object) @see String#equals // String.equals(java.lang.Object) @see java.lang.Object#wait(long) // java.lang.Object.wait(long) @see Character#MAX_RADIX // Character.MAX_RADIX @see Java Spec // Java Spec @see "The Java Programming Language" // "The Java Programming Language"You can extend
@see
to link to classes not being documented by using the-link
option.For more details, see writing @see tags.
@serial
field-description| include | exclude
- Used in the doc comment for a default serializable field.
An optional field-description should explain the meaning of the field and list the acceptable values. If needed, the description can span multiple lines. The standard doclet adds this information to the serialized form page.
If a serializable field was added to a class some time after the class was made serializable, a statement should be added to its main description to identify at which version it was added.
The
include
andexclude
arguments identify whether a class or package should be included or excluded from the serialized form page. They work as follows:
- A public or protected class that implements
Serializable
is included unless that class (or its package) is marked@serial exclude
.- A private or package-private class that implements
Serializable
is excluded unless that class (or its package) is marked@serial include
.Examples: The
javax.swing
package is marked@serial exclude
(inpackage.html
orpackage-info.java
). The public classjava.security.BasicPermission
is marked@serial exclude
. The package-private classjava.util.PropertyPermissionCollection
is marked@serial include
.The tag @serial at a class level overrides @serial at a package level.
For more information about how to use these tags, along with an example, see "Documenting Serializable Fields and Data for a Class," Section 1.6 of the Java Object Serialization Specification. Also see the Serialization FAQ, which covers common questions, such as "Why do I see javadoc warnings stating that I am missing @serial tags for private fields if I am not running javadoc with the -private switch?". Also see Sun's criteria for including classes in the serialized form specification.
@serialField
field-name field-type field-description- Documents an
ObjectStreamField
component of aSerializable
class'sserialPersistentFields
member. One@serialField
tag should be used for eachObjectStreamField
component.
@serialData
data-description- The data-description documents the types and order of data in the serialized form. Specifically, this data includes the optional data written by the
writeObject
method and all data (including base classes) written by theExternalizable.writeExternal
method.The
@serialData
tag can be used in the doc comment for thewriteObject
,readObject
,writeExternal
,readExternal
,writeReplace
, andreadResolve
methods.
@since
since-text- Adds a "Since" heading with the specified since-text to the generated documentation. The text has no special internal structure. This tag is valid in any doc comment: overview, package, class, interface, constructor, method or field. This tag means that this change or feature has existed since the software release specified by the since-text. For example:
@since 1.5For source code in the Java platform, this tag indicates the version of the Java platform API specification (not necessarily when it was added to the reference implementation). Multiple @since tags are allowed and are treated like multiple @author tags. You could use multiple tags if the prgram element is used by more than one API.
@throws
class-name description- The
@throws
and@exception
tags are synonyms. Adds a "Throws" subheading to the generated documentation, with the class-name and description text. The class-name is the name of the exception that may be thrown by the method. This tag is valid only in the doc comment for a method or constructor. If this class is not fully-specified, the Javadoc tool uses the search order to look up this class. Multiple@throws
tags can be used in a given doc comment for the same or different exceptions.To ensure that all checked exceptions are documented, if a
@throws
tag does not exist for an exception in the throws clause, the Javadoc tool automatically adds that exception to the HTML output (with no description) as if it were documented with @throws tag.The
@throws
documentation is copied from an overridden method to a subclass only when the exception is explicitly declared in the overridden method. The same is true for copying from an interface method to an implementing method. You can use {@inheritDoc} to force @throws to inherit documentation.For more details, see writing @throws tags.
{@value
package.class#field}
- When
{@value}
is used (without any argument) in the doc comment of a static field, it displays the value of that constant:/** * The value of this constant is {@value}. */ public static final String SCRIPT_START = "


See: Description
| Package | Description |
|---|---|
| com.tinmegali.security.mcipher | |
| com.tinmegali.security.mcipher.exceptions |
This simple library aims to reduce the overhead necessary to securely encrypt and decrypt files in the Android system. It relies only in Android native libraries, making use of the KeyStore, combined with SecretKey or KeyPair to make the encryption and decryption process.
The MCipher is currently in development process, but it is pretty stable so far.
The encryption and decryption process relies on two interfaces,
MEncryptor
and
MDecryptor
.
All you have to do is build the interfaces,
providing a common 'alias' for both MEcnryptor and MDecryptor and you're good to go.
Keep in mind that it could be a good idea to make the encryption and decryption using background task, otherwise your ui thread may be compromised.
// a good idea is to use your package name as a foundation for the 'alias'
String ALIAS = "my.package.name.mcipher.alias"
MEncryptor encryptor = new MEncryptorBuilder( ALIAS ).build();
MDecryptor decryptor = new MDecryptorBuilder( ALIAS ).build();
String toEncrypt = "encrypt this string";
// encrypting
String encrypted = encryptor.encryptString( toEncrypt, this );
// decrypting
String decrypted = decryptor.decryptString( encrypted, this );
You can download MCipher from jcenter directly. Don't forget to point to 'jcenter' distribution center.
<dependency>
<groupId>com.tinmegali.android</groupId>
<artifactId>mcipher</artifactId>
<version>0.4</version>
<type>pom</type>
</dependency>
compile 'com.tinmegali.android:mcipher:0.4'


All implementations must support a character repertoire called standard-char; characters that are members of that repertoire are called standard characters.
 Standard Character Subrepertoire (Part 1 of 3: Latin Characters)
Graphic ID Glyph Description Graphic ID Glyph Description ND01 1 digit 1 ND06 6 digit 6 ND02 2 digit 2 ND07 7 digit 7 ND03 3 digit 3 ND08 8 digit 8 ND04 4 digit 4 ND09 9 digit 9 ND05 5 digit 5 ND10 0 digit 0
Figure 2-4. Standard Character Subrepertoire (Part 2 of 3: Numeric Characters)
The graphic IDs are not used within Common Lisp, but are provided for cross reference purposes with ISO 6937/2. Note that the first letter of the graphic ID categorizes the character as follows: L---Latin, N---Numeric, S---Special.


Kondokali, the village where Gouvia Marina is sited, was once a small fishing port. Situated 5nm NW of Corfu port it has now become a popular tourist resort, in particular with the English. Cruisers can easily find a good English pint, newspaper and breakfast here.
The marina is owned and managed by K&G Med Marinas, who also operate Levkas, Kalamata, Zea Marinas. It is a popular charter/flotilla base and used as a winter base for many cruising boats.
When approaching from Corfu's northern channel the islet of Lazaretto is a landmark about a mile south of the entrance.
The channel is marked by 2 pairs of light buoys, with depths 8 to 9 meters in the middle. These buoys are lit (range about 1 mile) but cannot always be relied on, so a night entry is not advisable. It is important to follow the marked channel carefully as there are extensive shallows on each side of it.
For full details on clearing into our out of Greece see Greek Formalities.
During the summer (May to September), Gouvia marina can be used as a Port of Entry. The Officials are located on site, next to the marina office, and clearance is simple and straightforward and much easier than in Corfu town. All fees due to the Greek Authorities can be paid at the marina office. Open 0900-1430.
According to a ministerial directive which came into effect in September 2007, every boat over 7metres that enters Greece and is not permanently moored in the country, is obliged to pay a fee of 15€ each time they enter the country. The relative directive is valid all over Greece, however noonsite has only heard of Gouvia Port Police charging this "cruising permit" fee in 2013.
Outside of the summer months, it may be necessary to take a taxi to Corfu town to complete formalities.
Last updated February 2016.
Gouvia Marina is located in the SE corner of the closed bay of Gouvia (Ormos Gouvion). The marina is the only mooring option here as anchoring is prohibited in the bay.
Gouvia marina is surrounded by a developed tourist area full of restaurants, bars and hotels within walking distance of the 2 entrances. The centre of Corfu town is about 7 km away with a regular bus service on the main road.
Moor stern/bows-to where directed by the berthing master and report to the office. Normally you will be met on arrival by a RIB and guided to your berth. Moorings are connected to the quay and a yacht's own anchor should not be used. In places where this is missing (as some of them are!), moor in the usual Mediterranean fashion. See marina website for current price list.
Shelter varies according to position within the marina. Berths on the west side and those to the east of the central pier are less comfortable in strong north easterlies.
Anchoring
It is possible to anchor in Ormos Kammeno, just to the N of the harbour, in about 5-12m in mud and weed. It is sheltered in all winds except from the SE, but it is advisable to take a long line ashore if possible.
Last updated February 2016.


Next two month’s written work plan (time divisions) 1th April-10th April: After attending courses of writing a literature review and being your good editor, I gain a better awareness and a deeper understanding of academic writing. Using historical context review as an exercising material, revise the review within 10th April (around 4000-5000 words). 1th April-17th April: Organizing the literature review on innovation theory and history within next two weeks—finish draft before 17th April (around 3000-5000 words) 18th April-30th April: Organizing the existing written materials of the review of fashion globalizations and remediations by 30th April (around 5000 words). At the...…
Research Diary 27th March 2016
Solve problems on the following questions The methodologies of doing culture research and how to apply them into my research? How to ask valid questions that can help me acquire the information I need? Readings key words: Semiotics, culture research, design culture. Semiotics and content analysis are two main research methods that are worth to think about when undertaking cultural research. Research Capability training methods stage 1: Read on related PHD thesis and write conclusions, training the following questions. A.Rewrite the abstract following personal understanding B.Find out the skeletons of each research and try to think of how each research...…
An Introduction to My Project
The proliferation of technology, performativity and theatricality in contemporary runways whose dramatics are increasingly being reinforced through various methods is gradually becoming an assignable phenomenon in today’s fashion industry. The prosperous development of the fashion industry in China is also increasingly attracting the attention of both academics and industry professionals. However, the cultural and aesthetic value of fashion shows staged by luxury brands tend to be overlooked. …


| OLD line(s): 35
| NEW line(s): 36
<xsd:include schemaLocation="../../CorporateIncomeTax/Common/IRS4562FY/IRS4562FY.xsd"/> |
| OLD line(s): 97
| NEW line(s): 99,101
<xsd:include schemaLocation="../../CorporateIncomeTax/Common/Dependencies/50YearADSDeductionStatement.xsd" /> <xsd:include schemaLocation="../../CorporateIncomeTax/Common/Dependencies/50YearGDSDeductionStatement.xsd" /> <xsd:include schemaLocation="../../CorporateIncomeTax/Common/Dependencies/AmortizationElectionStatement.xsd" /> |
| OLD line(s): 115
| NEW line(s): 120
<xsd:include schemaLocation="../../CorporateIncomeTax/Common/Dependencies/Section168f1PropertyExplanationStatement.xsd" /> |
| OLD line(s): 124
<xsd:include schemaLocation="../Common/Dependencies/DissolutionStatement.xsd"/> | NEW line(s): 128
|
| OLD line(s): 131
<xsd:include schemaLocation="../Common/Dependencies/LiquidationExplanationStatement.xsd"/> | NEW line(s): 134
|
| OLD line(s): 143
<xsd:include schemaLocation="IRS990EZ/ProxyTaxExplanation.xsd"/> | NEW line(s): 145
|
| OLD line(s): 251,256
<!-- Includes for 4562 (supporting info, schedules, computations, and such) --> <xsd:include schemaLocation="../../CorporateIncomeTax/Common/IRS4562/50YearADSDeductionStatement.xsd"/> <xsd:include schemaLocation="../../CorporateIncomeTax/Common/IRS4562/50YearGDSDeductionStatement.xsd"/> <xsd:include schemaLocation="../../CorporateIncomeTax/Common/IRS4562/AmortizationElectionStatement.xsd"/> <xsd:include schemaLocation="../../CorporateIncomeTax/Common/IRS4562/Section168f1PropertyExplanationStatement.xsd"/> | NEW line(s): 252
|
| OLD line(s): 581
| NEW line(s): 578,584
<!-- Form 4562FY --> <xsd:element ref="IRS4562FY" minOccurs="0" maxOccurs="10000"> <xsd:annotation> <xsd:documentation>IRS Form 4562FY - Depreciation and Amortization (Including Information on Listed Property)</xsd:documentation> </xsd:annotation> </xsd:element> |
| OLD line(s): 1115,1121
<xsd:element ref="ProxyTaxExplanation" minOccurs="0"> <xsd:annotation> <xsd:documentation>Proxy tax explanation</xsd:documentation> </xsd:annotation> </xsd:element> <!-- Form 990-EZ attachment --> | NEW line(s): 1117
|
| OLD line(s): 1744
<!-- Form 4562 statement --> | NEW line(s): 1740
<!-- Form 4562 and Form 4562FY Statement --> |
| OLD line(s): 1751
<!-- Form 4562 statement --> | NEW line(s): 1747
<!-- Form 4562 and Form 4562FY Statement --> |
| OLD line(s): 1758
<!-- Form 4562 statement --> | NEW line(s): 1754
<!-- Form 4562 and Form 4562FY Statement --> |
| OLD line(s): 1765
<!-- Form 4562 statement --> | NEW line(s): 1761
<!-- Form 4562 and Form 4562FY Statement --> |


Folders
<Go Back>
3-frames-...indows
6-data-storage
8-web-components
1-js
4-binary
7-animation
9-regular...ssions
2-ui
5-network
Folders: 10


| Modifier and Type | Field and Description |
|---|---|
protected GraphVertex |
ComputationGraphSpace.VertexConf.graphVertex |
| Modifier and Type | Method and Description |
|---|---|
ComputationGraphSpace.Builder |
ComputationGraphSpace.Builder.addVertex(String vertexName,
GraphVertex vertex,
String... vertexInputs) |
| Modifier and Type | Field and Description |
|---|---|
protected Map<String,GraphVertex> |
ComputationGraphConfiguration.vertices |
protected Map<String,GraphVertex> |
ComputationGraphConfiguration.GraphBuilder.vertices |
| Modifier and Type | Method and Description |
|---|---|
ComputationGraphConfiguration.GraphBuilder |
ComputationGraphConfiguration.GraphBuilder.addVertex(String vertexName,
GraphVertex vertex,
String... vertexInputs)
Add a
GraphVertex to the network configuration. |
ComputationGraphConfiguration.GraphBuilder |
ComputationGraphConfiguration.GraphBuilder.appendVertex(String vertexName,
GraphVertex vertex)
Add a
GraphVertex to the network configuration, with input from the last added vertex/layer. |
| Modifier and Type | Class and Description |
|---|---|
class |
AttentionVertex
Implements Dot Product Attention using the given inputs.
|
class |
ElementWiseVertex
An ElementWiseVertex is used to combine the activations of two or more layer in an element-wise manner
For example, the activations may be combined by addition, subtraction, multiplication (product), average or by selecting the maximum. |
class |
FrozenVertex
FrozenVertex is used for the purposes of transfer learning.
|
class |
L2NormalizeVertex
L2NormalizeVertex performs L2 normalization on a single input, along the specified dimensions.
|
class |
L2Vertex
L2Vertex calculates the L2 (Euclidean) least squares error of two inputs, on a per-example basis.
|
class |
LayerVertex
LayerVertex is a GraphVertex with a neural network Layer (and, optionally an
InputPreProcessor ) in it |
class |
MergeVertex
A MergeVertex is used to combine the activations of two or more layers/GraphVertex by means of concatenation/merging.
|
class |
PoolHelperVertex
Removes the first column and row from an input.
|
class |
PreprocessorVertex
PreprocessorVertex is a simple adaptor class that allows a
InputPreProcessor to be used in a ComputationGraph
GraphVertex, without it being associated with a layer. |
class |
ReshapeVertex
Adds the ability to reshape and flatten the tensor in the computation graph.
|
class |
ScaleVertex
A ScaleVertex is used to scale the size of activations of a single layer: this is simply multiplication by a
fixed scalar value
For example, ResNet activations can be scaled in repeating blocks to keep variance under control. |
class |
ShiftVertex
A ShiftVertex is used to shift the activations of a single layer.
|
class |
StackVertex
StackVertex allows for stacking of inputs so that they may be forwarded through a network.
|
class |
SubsetVertex
SubsetVertex is used to select a subset of the activations out of another GraphVertex.
|
class |
UnstackVertex
UnstackVertex allows for unstacking of inputs so that they may be forwarded through
a network.
|
| Modifier and Type | Method and Description |
|---|---|
GraphVertex |
FrozenVertex.clone() |
abstract GraphVertex |
GraphVertex.clone() |
GraphVertex |
LayerVertex.clone() |
GraphVertex |
PreprocessorVertex.clone() |
| Constructor and Description |
|---|
FrozenVertex(GraphVertex underlying) |
| Modifier and Type | Class and Description |
|---|---|
class |
DuplicateToTimeSeriesVertex
DuplicateToTimeSeriesVertex is a vertex that goes from 2d activations to a 3d time series activations, by means of
duplication.
|
class |
LastTimeStepVertex
LastTimeStepVertex is used in the context of recurrent neural network activations, to go from 3d (time series)
activations to 2d activations, by extracting out the last time step of activations for each example.
|
class |
ReverseTimeSeriesVertex
ReverseTimeSeriesVertex is used in recurrent neural networks to revert the order of time series.
|
| Modifier and Type | Method and Description |
|---|---|
GraphVertex |
DuplicateToTimeSeriesVertex.clone() |
GraphVertex |
LastTimeStepVertex.clone() |
| Modifier and Type | Class and Description |
|---|---|
class |
SameDiffLambdaVertex
SameDiffLambdaVertex is defined to be used as the base class for implementing lambda vertices using SameDiff
Lambda vertices are vertices without parameters - and as a result, have a much simpler API - users need only extend SameDiffLambdaVertex and implement a single method to define their vertex |
class |
SameDiffVertex
A SameDiff-based GraphVertex.
|
| Modifier and Type | Method and Description |
|---|---|
GraphVertex |
SameDiffLambdaVertex.clone() |
| Modifier and Type | Field and Description |
|---|---|
protected GraphVertex |
KerasLayer.vertex |
| Modifier and Type | Method and Description |
|---|---|
GraphVertex |
KerasLayer.getVertex()
Gets corresponding DL4J Vertex, if any.
|
| Modifier and Type | Method and Description |
|---|---|
TransferLearning.GraphBuilder |
TransferLearning.GraphBuilder.addVertex(String vertexName,
GraphVertex vertex,
String... vertexInputs)
Add a vertex of the given configuration to the computation graph
|
Copyright © 2020. All rights reserved.


How does it work
The situation#
So why should you bother creating all those migration files instead of using the backend UI? The issue is that database changes work in a linear fashion, which is hardly "mergeable" automatically. If you don't need to merge different changes to your ProcessWire database, you won't need migrations. But chances are high that you do need to do that at some time.
For example migrating changes between a running live system and a development system. It's super easy to push changes to template files or other code from development to the live server. But it's harder when it comes to changes affecting the database a.k.a changes to fields, templates or pages. Consider a scenario where a website is live and your client or other users are creating content online. At the same time you're developing new features for a few weeks or even month on your local machine. When it comes to moving those changes to the live site you need to merge your changes with the changes that happened on the live site.
Doing those kind of updates by hand is slow (downtime for the site) and can quite easily lead to errors if something is not 100% correctly transfered. A good amout of discipline in documentation while adding changes locally can improve these issues, but it's still a manual process that does take some time. This is especially apparent if multiple people work on the project and changes come from different people.
Migration files take the ambiguity out of this task by moving all needed changes into executable code. This way any database modifications can be reliably recreated on the live system and even be automated. Additionally those migrations can be added to source control – with all it's benefits – and are also easy to share to collaborators.
Evaluation#
The TL;DR points for using the module and migration files.
Pro:
- Automate changes
- Trackable by source control
- Simple to share
- Fast run/rollback to switch between configurations
Cons:
- Migrations need to be created for each change affecting the db
- Changes directly via the Admin UI should be avoided
Workflow#
So you get why you need to use migrations, but how does it actually work. In short: Not much different than before. You'll still add fields, change template settings or add "static" pages to your installation. Only that you won't do it via the backend UI, but rather by coding those changes with the ProcessWire API. On a high level this will look like that:
| update() | downgrade() | ||
|---|---|---|---|
| Common Base | |||
| Create the author field | ↓ | ↑ | Delete the author field |
| Create the blog-post template | ↓ | ↑ | Delete the blog-post template |
| Install SchedulePages module | ↓ | ↑ | Deinstall SchedulePages module |
| Add the blog root page | ↓ | ↑ | Remove the blog-root |
| … |
You'll probably understand the left part of the table – but why bother implementing the removal of those changes as well? This is really mainly a workflow improvement as well as a savety net. If you can always rollback your changes you can undo any potentially erroneous migrations at any time and probably much quicker than manually.
Even if it's not about errors, you can also use this to improve local work, too. For example in a multi-branch git workflow one might often switch between different branches. This will update the codebase, but not the database state. By rolling back migrations of the current branch, then switching the git branch and migrating all changes for the other branch one can keep file and db modifications in sync.


{% extends "base.html" %} {% block content %} {% load format_html_tag %}
Here you can download the full model configuration to use again in the future, and/or download the results from the last run. You can also use the downloaded configuration with the command-line version of MusicBox.


{% extends "rvu/base.html" %} {% load crispy_forms_tags %} {% block content %}
Are you sure you want to delete "{{ object }}"?


Behavior
Small and seemingly weak, Rattata has a fighting character. If you attack her, she will not run away, rather, she will attack and start biting off her nose.


Eigenvectors of a matrix are those vectors, which, multiplied with the matrix, are scalar multiples of themselves.
λ is the eigenvalue.
Eigenvalues can be found by solving the equation
det(A - λ I) =0 (I = identity matrix).
The eigenvectors are then calculated from (A - λI) = 0.
Eigenvalues and eigenvectors of structural orientation data can be
explained with a physical model.
Supposing the data are represented by mass points on the globe (with
the masses m = 1), two axes must exist which have a maximum and a minimum
moment of inertia. a third axis is normal to these two axes. With these three
axes an ellipsoid can be constructed in analogy to the stress- or strain-ellipsoid.
This ellipsoid is called the orientation-ellipsoid. the corresponding tensor
is the orientation tensor


Required Files
- shoes/encoding
- open-uri
- optparse
- resolv-replace
- shoes/inspect
- shoes/cache
- shoes/image
- shoes/shybuilder
- shoes/setup
- shoes/search
- shoes/help
- shoes/pack
- shoes/search
- shoes/help
- shoes/log
- shoes/shy
Namespace
- MODULE Shoes::Basic
- CLASS Range
- CLASS Shoes
- CLASS Shoes::SettingUp
- CLASS Shoes::Types::Widget


I am a PhD candidate at Systems Group, ETH Zurich. My research is about making advanced analytics faster and efficient in terms of resource and power usage. To achieve this, I am designing specialized hardware performing inherently parallel and compute/data intensive tasks that a conventional CPU is not suitable for. My goal is to provide insights into how the evolution of hardware in the era of big data shall continue after the end of Moore's Law.
I am a former DAAD scholar and received my BSc and MSc degrees from KIT with distinction. Aside from pursuing my PhD, I occasionally work in industry, participate in engineering competitions and enjoy the Swiss Alps skiing.


Click here to download this week's dataset as a CSV
Click here to download this week's dataset as a Hyper Extract
Data Storytelling and Data Viz Approach
The nature of this data lends itself to mapping. I chose to use a hex map to prevent the relative size of each of the states from detracting from the overall data story. As with most of my visualizations, I strove for interaction - the user can choose a starting year, as well as length of the period to analyze. I achieved both of these with parameters. The users choice then drives all of the visualization on the dashboard.
For the hexmap, I wanted to highlight the most common grain harvested by state for the selected timeframe. I achieved this using a rank (table calc), and filtering this rank to equal 1. To add to the interactivity, I added a Viz in Tooltip to show the acres harvested for all grains. I love Tableau 2018.1's new feature that enables hiding Viz in Tooltip sheets without 'hiding' them on the dashboard.
A nice big set of BANs above the map highlight the number of acres harvested by grain. To enhance the visual aspect of the bans, I also added a bar chart to the right of the hex map. It's a bit of a duplication, but helps to make the map fit the dashboard more appropriately. I finished up the dashboard with a line graph showing acres harvested by grain by year. I used the same dual axis (line and area) technique that I detailed last week to highlight the selected timeframe, while still showing the full data story.
Data Notes
Data is presented as downloaded from the USDA NASS Datatool with the exception of both Corn and Sorghum acres harvested. The data denoted as Corn - Acres Harvested, includes the Grain, Silage and Forage numbers for Corn. Similarly, for Sorghum, the Sorghum - Acres Harvested includes the Grain and Silage numbers.
Data Source
This week's data source comes from the United States Department of Agriculture, National Agriculture Statistics Service. The picture this week is of the wheat field behind my house.


Edit 6 Flips the buffer about the pivot point.
Press 6 to Flip the segments in the buffer relative to the pivot point.
This feature is independent of the cursor position.
The Flip Axis is set using Edit 0 - Mirror.
Note that this operation undoes itself by pressing 6 again.


A view is a view of all entities (File, Folder, Project, Table, Docker Repository, View) within one or more Projects or Folders. Views can:
Preliminaries:
library(synapser)
##
## TERMS OF USE NOTICE:
## When using Synapse, remember that the terms and conditions of use require that you:
## 1) Attribute data contributors when discussing these data or results from these data.
## 2) Not discriminate, identify, or recontact individuals or groups represented by the data.
## 3) Use and contribute only data de-identified to HIPAA standards.
## 4) Redistribute data only under these same terms of use.
synLogin()
## Welcome, test!
## NULL
# Create a new project
# use hex_digits to generate random string
c(as.character(0:9), letters[1:6])
hex_digits <- sprintf("My unique project %s", paste0(sample(hex_digits, 32, replace = TRUE), collapse = ""))
projectName <- Project(projectName)
project <- synStore(project)
project <-
# Create some files
tempfile()
filePath <- file(filePath)
connection <-writeChar("this is the content of the first file", connection, eos = NULL)
close(connection)
File(path = filePath, parent = project)
file <- synStore(file)
file <-## ################################################## Uploading file to Synapse storage ##################################################
--------------------]0.00% 0.0bytes/37.0bytes file86104a1ec12b
Uploading [####################]100.00% 37.0bytes/37.0bytes (31.0bytes/s) file86104a1ec12b Done...
Uploading [
tempfile()
filePath2 <- file(filePath2)
connection2 <-writeChar("this is the content of the second file", connection, eos = NULL)
close(connection2)
File(path = filePath2, parent = project)
file2 <- synStore(file2)
file2 <-## ################################################## Uploading file to Synapse storage ##################################################
--------------------]0.00% 0.0bytes/38.0bytes file8610291c1411
Uploading [####################]100.00% 38.0bytes/38.0bytes (67.4bytes/s) file8610291c1411 Done...
Uploading [
# add some annotations
synSetAnnotations(file, list(contributor = "Sage", class = "V"))
## $class
## $class[[1]]
## [1] "V"
##
##
## $contributor
## $contributor[[1]]
## [1] "Sage"
synSetAnnotations(file2, list(contributor = "UW", rank = "X"))
## $rank
## $rank[[1]]
## [1] "X"
##
##
## $contributor
## $contributor[[1]]
## [1] "UW"
Creating a View:
EntityViewSchema(name = "my first file view",
view <-columns = c(
Column(name = "contributor", columnType = "STRING"),
Column(name = "class", columnType = "STRING"),
Column(name = "rank", columnType = "STRING")),
parent = project$properties$id,
scopes = project$properties$id,
includeEntityTypes = c(EntityViewType$FILE, EntityViewType$FOLDER),
add_default_columns = TRUE)
synStore(view)
view <-##
####################]100.00% 1/1 Done... [
We support the following entity type in a View:
EntityViewType
## $DOCKER
## EntityViewType.DOCKER
##
## $FILE
## EntityViewType.FILE
##
## $FOLDER
## EntityViewType.FOLDER
##
## $PROJECT
## EntityViewType.PROJECT
##
## $TABLE
## EntityViewType.TABLE
##
## $VIEW
## EntityViewType.VIEW
To see the content of your newly created View, use synTableQuery():
synTableQuery(sprintf("select * from %s", view$properties$id))
queryResults <-##
####################]100.00% 1/1 Done...
[####################]100.00% 834.0bytes/834.0bytes (502.1kB/s) SYNAPSE_TABLE_QUERY_2926613.csv Done...
Downloading [ as.data.frame(queryResults)
data <-
data## ROW_ID ROW_VERSION ROW_ETAG id
## 1 11769481 1 4836e928-7466-44a7-8764-0b80b0de8dc3 syn11769481
## 2 11769482 1 c12a41f9-bd78-434b-98a3-c9739e4d459f syn11769482
## name createdOn createdBy
## 1 file86104a1ec12b 2021-04-28 22:02:16 3336368
## 2 file8610291c1411 2021-04-28 22:02:18 3336368
## etag type currentVersion parentId
## 1 4836e928-7466-44a7-8764-0b80b0de8dc3 file 1 syn11769480
## 2 c12a41f9-bd78-434b-98a3-c9739e4d459f file 1 syn11769480
## benefactorId projectId modifiedOn modifiedBy dataFileHandleId
## 1 syn11769480 syn11769480 2021-04-28 22:02:19 3336368 2926611
## 2 syn11769480 syn11769480 2021-04-28 22:02:19 3336368 2926612
## dataFileSizeBytes dataFileMD5Hex contributor class rank
## 1 37 47dfe7f5eaa49a5413c7b79b67ab9c43 Sage V <NA>
## 2 38 ba01e01b9e3ffea3ebef95efa62998b0 UW <NA> X
To update ‘class’ annotation for ‘file2’, simply update the view:
The change in annotations is reflected in synGetAnnotations():
synGetAnnotations(file2$properties$id)
A unique etag is associated with every file that updates when changes are made to a file, including the contents, annotations, or metadata. Any updates pushed to Synapse will change an object’s etag.
data$etag
There may be cases where you want to update the annotations on a subset of files in a view. In order to preserve the etag, and thus the file history, you will need to store only the rows that have been modified.
$contributor[1] <- c("Sage Bionetworks")
datasynStore(Table(view$properties$id, data[1,]))
##
--------------------]0.00% 0.0bytes/555.0bytes file861036131520
Uploading [####################]100.00% 555.0bytes/555.0bytes (503.7bytes/s) file861036131520 Done...
Uploading [####################]100.00% 1/1 Done...
[## <synapseclient.table.CsvFileTable object at 0x143ff3080>
A view can contain different types of entity. To change the types of entity that will show up in a view:
A View is a Table. Please visit Tables vignettes to see how to change schema, update content, and other operations that can be done on View.
synDelete(project)
## NULL


Resources
If you want to learn about mental health conditions, you've come to the right place!
Quick Links
Local Organizations
| Name | Contact | Address | Focus |
|---|---|---|---|
| ADAPT of Missouri |<PHONE_NUMBER> | 2301 Hampton Ave. 63139 | Adults living with mental illness |
| Alternative Behavioral Care | 636-477-611 | 255 Spencer Rd., Suite 101 St. Peters 63376 | All-age mental health and substance abuse help programs. |
| Center for Life Solutions |<PHONE_NUMBER> | 1077 S. Newstead Ave. 63110 | Medical evaluations as well as therapy for state/medicaid/private payments |
| Community Psychological Services |<PHONE_NUMBER> | 232 Stadler Hall, One University Blvd. 63121 | Affordable psychological services to St. Louis metropolitan residents |
| Karla Smith Foundation |<PHONE_NUMBER> | 14 Park Place, Suite B, Swansea, IL 62226 | Help offered to family members and others affected by mental illness/suicide. Support groups for coping with grief and peer-to-peer coaching. |
| Kingdom House |<PHONE_NUMBER> | 1321 South 11th St. 63104 | Counseling, family support, and more geared towards low-income clients |
| Mental Health America of Eastern Missouri | 3314-773-6752 | 1905 S. Grand Blvd. 63104 | Tons more resources, seminars, and programs going on all the time. |
| Kingdom House |<PHONE_NUMBER> | 1321 South 11th St. 63104 | Counseling, family support, and more geared towards low-income clients |
| Kingdom House |<PHONE_NUMBER> | 1321 South 11th St. 63104 | Counseling, family support, and more geared towards low-income clients |
Mental Health Facts
Here are a bunch of links to possible mental health issues from the Missouri Department of Mental Health:
Statistics
Statista
Contact a Doctor
The first person you should go to is your physician. While it may be uncomfortable, they're there to help you and can provide the professional help needed.
Time with doctors is limited, so it's good to come prepared. Exporting data from here is a great way to help the doctor diagnose any problems effectively and come prepared to those meetings.
Remember, it's totally okay to get help for this. Mental health issues aren't something you can just get over. So, go get help and feel a lot better!
Hotlines
If the situation is feeling pretty dire, these call centers can help you through it.