Version 0.2.22 Tag
Values
Location
Usage
@affected
Browser and version, or a group of useragents Identity of the author, probably email None
File Comment Section Comment
Name a browser version for a bugfix or workaround
File Comment
Name the author. For multiple authors use multiple tags, one per author. Documentation of CSS bugfixes. Use with: @affect, @css-for, @valid
@author
@bugfix
@colordef @copyright @creator
@css-for
CSS color value, name and usage Copyright string Name of creating application Name of fixed browser
File Comment, Section Comment Standard CSS Comment File Comment
Copyright information of file
File Comment
A CSS-Generating Application or Tool can leave its fingerprint here
File Comment Section Comment File Comment Section Comment File Comment
Naming the browser rules have been written for
Definition of the fonts used in the document Document last date of modification
A CSSDoc Command
@date
Date (tag value)
@fontdef
File Comment
@link
Fontdef (tag value) Timestamp of the last modification Might be a URL followed by a description Hyperlink
@note
Text
@package
@lastmodified
@license
Definition of a color.
File Comment
@cssdoc
File Comment
Controlling and signaling a CSSDoc parser
Reference since which version a section or file exists
Section Comment
File Comment
File referencing hyperlink Drop a note
Package name
File Comment Section Comment File Comment
@section
Section name
Section Comment
@see
Text, URL
@since
Version number
@since-revision
Revision number
@site
Text
File Comment Section Comment File Comment Section Comment File Comment Section Comment File Comment
@style
Text
File Comment
Name a site that this style has been made for Style that the file is part of
@subpackage
Subpackage name Subsection name Subsubsection name List of tested browsers
File Comment
Packaging
Section Comment
Adding structure to a CSS file
Section Comment
Adding structure to a CSS file
File Comment Section Comment File Comment Section Comment File Comment Section Comment File Comment
Note which browsers a section has been tested with
File Comment Section Comment
Flag a workaround Use with: @bugfix (may replace it)
@tested @todo
Text
@valid
True/False
@version
Version Number
@workaround
None or short description of the bugfix
Developed by Talita Pagani
File Comment
Reference more info for a section or the file
To specify the license that the file is released under
@subsubsection
Sample DocBlocks
/** * My Website * * Standard layout for My Website * * This style sheet describes the * structure and the main components * about My Website interface * * @project My Website * @version 1.0 * @package layout * @author John Doe * @copyright 2010 A Company, Inc. * * @colordef #069; standard blue * @colordef #333; standard dark * @colordef #666; standard gray */
Document creation date of file
File Comment
@subsection
CSS DocBlock Structure
Associates one or multiple files to a package Open and name a new section
Reference since which version a section or file exists
Create a todolist on the fly Can use with: @version Flag validity CSS Specify the file version
/** * Page Structure * * Main structure and common * components of website * such as Wrapper, Navbar, Header and * Footer * * @section structure * @see http://www.example.com */
Bugfix /** * Disappearing list-background bug * * @bugfix * @affected IE 5.x/Win, IE6 * @css-for IE 5.x/Win, IE6 * @valid true */
Last revision: 26 Dec. 2010