Skip to content

Commit

Permalink
Unify *doc modes across all languages and styles
Browse files Browse the repository at this point in the history
  • Loading branch information
@Sannis
Sannis committed Apr 26, 2015
1 parent 88692f4 commit d9b73e9
Show file tree
Hide file tree
Showing 43 changed files with 114 additions and 207 deletions.
28 changes: 4 additions & 24 deletions docs/css-classes-reference.rst
View file
Expand Up @@ -40,7 +40,7 @@ Ruby ("ruby", "rb", "gemspec", "podspec", "thor", "irb")
* ``string``: string
* ``subst``: in-string substitution (#{...})
* ``comment``: comment
* ``yardoctag``: YARD tag
* ``doctag``: YARD doctag
* ``function``: function header "def some_name(...):"
* ``class``: class header "class SomeName(...):"
* ``title``: name of a function or a class inside a header
Expand Down Expand Up @@ -84,7 +84,7 @@ PHP ("php", "php3", "php4", "php5", "php6")
* ``number``: number
* ``string``: string (of any type)
* ``comment``: comment
* ``phpdoc``: phpdoc params in comments
* ``doctag``: phpdoc params in comments
* ``variable``: variable starting with "$"
* ``preprocessor``: preprocessor marks: "<?php" and "?>"
* ``class``: class header
Expand All @@ -99,9 +99,8 @@ Scala ("scala")
* ``number``: number
* ``string``: string
* ``comment``: comment
* ``doctag``: @-tag in javadoc comment
* ``annotation``: annotation
* ``javadoc``: javadoc comment
* ``javadoctag``: @-tag in javadoc
* ``class``: class header
* ``title``: class name inside a header
* ``params``: everything in parentheses inside a class header
Expand All @@ -115,9 +114,8 @@ Groovy ("groovy")
* ``string``: string, map string keys and named argument labels
* ``regex``: regular expression
* ``comment``: comment
* ``doctag``: @-tag in javadoc comment
* ``annotation``: annotation
* ``javadoc``: javadoc comment
* ``javadoctag``: @-tag in javadoc
* ``class``: class header
* ``title``: class name inside a header
* ``label``: label
Expand Down Expand Up @@ -161,7 +159,6 @@ Lasso ("lasso", "ls", "lassoscript")
* ``preprocessor``: delimiters and interpreter flags
* ``shebang``: Lasso 9 shell script header
* ``comment``: single- or multi-line comment
* ``javadoc``: doc comment
* ``keyword``: keyword
* ``literal``: keyword representing a value
* ``built_in``: built-in types and variables
Expand Down Expand Up @@ -405,7 +402,6 @@ Dart ("dart")
* ``subst``: in-string substitution (${...})
* ``comment``: commment
* ``annotation``: annotation
* ``dartdoc``: dartdoc comment
* ``class``: class header from "class" till "{"
* ``title``: class name

Expand Down Expand Up @@ -574,7 +570,6 @@ Java ("java", "jsp")
* ``string``: string
* ``comment``: comment
* ``annotaion``: annotation
* ``javadoc``: javadoc comment
* ``class``: class header from "class" till "{"
* ``function``: method header
* ``title``: class or method name
Expand All @@ -598,7 +593,6 @@ AspectJ ("aspectj")
* ``number``: number
* ``keyword``: keyword
* ``annotation``: annotation
* ``javadoc``: javadoc comment
* ``function``: method and intertype method header
* ``aspect``: aspect header from "aspect" till "{"
* ``params``: everything in parentheses inside an aspect header
Expand Down Expand Up @@ -1358,20 +1352,6 @@ PF ("pf", "pf.conf")
* ``string``: string
* ``variable``: used for both macros and tables

C/AL ("cal")
-----------------

* ``keyword``: keyword
* ``comment``: comment (of any type)
* ``number``: number
* ``string``: string
* ``date``: date, time, or datetime
* ``function``: header of a procedure
* ``title``: name of an object or procedure inside a header
* ``params``: everything inside parentheses in a function's header
* ``class``: objects body
* ``variable``: reference to variables

Prolog ("prolog")
-----------------

Expand Down
2 changes: 1 addition & 1 deletion docs/style-guide.rst
View file
Expand Up @@ -43,7 +43,7 @@ This means that language names in style definition should be avoided:
}

There are also unique syntax elements that languages don't share with each other:
"javadoc" in Java, "attr_selector" in CSS, "doctype" in XML etc.
"attr_selector" in CSS, "doctype" in XML etc.
The best way to style them is by "packing" them into a group of selectors for a single CSS group of rules:

::
Expand Down
21 changes: 11 additions & 10 deletions src/languages/aspectj.js
View file
Expand Up @@ -18,16 +18,17 @@ function (hljs) {
keywords : KEYWORDS,
illegal : /<\//,
contains : [
{
className : 'javadoc',
begin : '/\\*\\*',
end : '\\*/',
relevance : 0,
contains : [{
className : 'javadoctag',
begin : '(^|\\s)@[A-Za-z]+'
}]
},
hljs.COMMENT(
'/\\*\\*',
'\\*/',
{
relevance : 0,
contains : [{
className : 'doctag',
begin : '(^|\\s)@[A-Za-z]+'
}]
}
),
hljs.C_LINE_COMMENT_MODE,
hljs.C_BLOCK_COMMENT_MODE,
hljs.APOS_STRING_MODE,
Expand Down
28 changes: 16 additions & 12 deletions src/languages/dart.js
View file
Expand Up @@ -70,18 +70,22 @@ function (hljs) {
keywords: KEYWORDS,
contains: [
STRING,
{
className: 'dartdoc',
begin: '/\\*\\*', end: '\\*/',
subLanguage: 'markdown',
subLanguageMode: 'continuous'
},
{
className: 'dartdoc',
begin: '///', end: '$',
subLanguage: 'markdown',
subLanguageMode: 'continuous'
},
hljs.COMMENT(
'/\\*\\*',
'\\*/',
{
subLanguage: 'markdown',
subLanguageMode: 'continuous'
}
),
hljs.COMMENT(
'///',
'$',
{
subLanguage: 'markdown',
subLanguageMode: 'continuous'
}
),
hljs.C_LINE_COMMENT_MODE,
hljs.C_BLOCK_COMMENT_MODE,
{
Expand Down
21 changes: 11 additions & 10 deletions src/languages/groovy.js
View file
Expand Up @@ -20,17 +20,18 @@ function(hljs) {
},

contains: [
hljs.COMMENT(
'/\\*\\*',
'\\*/',
{
relevance : 0,
contains : [{
className : 'doctag',
begin : '(^|\\s)@[A-Za-z]+'
}]
}
),
hljs.C_LINE_COMMENT_MODE,
{
className: 'javadoc',
begin: '/\\*\\*', end: '\\*//*',
relevance: 0,
contains: [
{
className: 'javadoctag', begin: '(^|\\s)@[A-Za-z]+'
}
]
},
hljs.C_BLOCK_COMMENT_MODE,
{
className: 'string',
Expand Down
19 changes: 11 additions & 8 deletions src/languages/java.js
View file
Expand Up @@ -25,14 +25,17 @@ function(hljs) {
keywords: KEYWORDS,
illegal: /<\//,
contains: [
{
className: 'javadoc',
begin: '/\\*\\*', end: '\\*/',
relevance: 0,
contains: [{
className: 'javadoctag', begin: '(^|\\s)@[A-Za-z]+'
}]
},
hljs.COMMENT(
'/\\*\\*',
'\\*/',
{
relevance : 0,
contains : [{
className : 'doctag',
begin : '(^|\\s)@[A-Za-z]+'
}]
}
),
hljs.C_LINE_COMMENT_MODE,
hljs.C_BLOCK_COMMENT_MODE,
hljs.APOS_STRING_MODE,
Expand Down
21 changes: 11 additions & 10 deletions src/languages/kotlin.js
View file
Expand Up @@ -17,17 +17,18 @@ function (hljs) {
keyword: KEYWORDS
},
contains : [
hljs.COMMENT(
'/\\*\\*',
'\\*/',
{
relevance : 0,
contains : [{
className : 'doctag',
begin : '(^|\\s)@[A-Za-z]+'
}]
}
),
hljs.C_LINE_COMMENT_MODE,
{
className: 'javadoc',
begin: '/\\*\\*', end: '\\*//*',
relevance: 0,
contains: [
{
className: 'javadoctag', begin: '(^|\\s)@[A-Za-z]+'
}
]
},
hljs.C_BLOCK_COMMENT_MODE,
{
className: 'type',
Expand Down
9 changes: 4 additions & 5 deletions src/languages/lasso.js
View file
Expand Up @@ -62,12 +62,11 @@ function(hljs) {
begin: '\'' + LASSO_IDENT_RE + '\''
};
var LASSO_CODE = [
hljs.COMMENT(
'/\\*\\*!',
'\\*/'
),
hljs.C_LINE_COMMENT_MODE,
{
className: 'javadoc',
begin: '/\\*\\*!', end: '\\*/',
contains: [hljs.PHRASAL_WORDS_MODE]
},
hljs.C_BLOCK_COMMENT_MODE,
hljs.inherit(hljs.C_NUMBER_MODE, {begin: hljs.C_NUMBER_RE + '|(-?infinity|nan)\\b'}),
hljs.inherit(hljs.APOS_STRING_MODE, {illegal: null}),
Expand Down
2 changes: 1 addition & 1 deletion src/languages/php.js
View file
Expand Up @@ -48,7 +48,7 @@ function(hljs) {
{
contains: [
{
className: 'phpdoc',
className: 'doctag',
begin: '\\s@[A-Za-z]+'
},
PREPROCESSOR
Expand Down
2 changes: 1 addition & 1 deletion src/languages/ruby.js
View file
Expand Up @@ -12,7 +12,7 @@ function(hljs) {
'next until do begin unless END rescue nil else break undef not super class case ' +
'require yield alias while ensure elsif or include attr_reader attr_writer attr_accessor';
var YARDOCTAG = {
className: 'yardoctag',
className: 'doctag',
begin: '@[A-Za-z]+'
};
var IRB_OBJECT = {
Expand Down
10 changes: 0 additions & 10 deletions src/languages/scala.js
View file
Expand Up @@ -47,16 +47,6 @@ function(hljs) {
contains: [NAME]
};

var JAVADOC = {
className: 'javadoc',
begin: '/\\*\\*', end: '\\*/',
contains: [{
className: 'javadoctag',
begin: '@[A-Za-z]+'
}],
relevance: 10
};

return {
keywords: {
literal: 'true false null',
Expand Down
3 changes: 1 addition & 2 deletions src/styles/agate.css
View file
Expand Up @@ -95,8 +95,7 @@
.tex .hljs-formula,
.hljs-header,
.hljs-horizontal_rule,
.hljs-code,
.hljs-javadoc {
.hljs-code {
color: #888;
}

Expand Down
4 changes: 0 additions & 4 deletions src/styles/androidstudio.css
View file
Expand Up @@ -21,10 +21,6 @@ Author: Pedro Oliveira <kanytu@gmail . com>
color: #cc7832;
}

.hljs-javadoc {
color: #629755;
}

.hljs-comment {
color: #808080;
}
Expand Down
5 changes: 1 addition & 4 deletions src/styles/arta.css
View file
Expand Up @@ -18,7 +18,6 @@ Author: pumbur <pumbur@pumbur.net>
}

.hljs-comment,
.hljs-javadoc,
.hljs-preprocessor,
.hljs-preprocessor .hljs-title,
.hljs-pragma,
Expand Down Expand Up @@ -112,9 +111,7 @@ Author: pumbur <pumbur@pumbur.net>
color: #bb1166;
}

.hljs-yardoctag,
.hljs-phpdoc,
.hljs-dartdoc,
.hljs-doctag,
.profile .hljs-header,
.ini .hljs-title,
.apache .hljs-tag,
Expand Down
1 change: 0 additions & 1 deletion src/styles/ascetic.css
View file
Expand Up @@ -30,7 +30,6 @@ Original style from softwaremaniacs.org (c) Ivan Sagalaev <Maniac@SoftwareManiac
.hljs-shebang,
.hljs-doctype,
.hljs-pi,
.hljs-javadoc,
.hljs-deletion,
.apache .hljs-sqbracket {
color: #ccc;
Expand Down
4 changes: 1 addition & 3 deletions src/styles/brown_paper.css
View file
Expand Up @@ -45,7 +45,6 @@ Brown Paper style from goldblog.com.ua (c) Zaripov Yura <yur4ik7@ukr.net>
.django .hljs-template_tag,
.django .hljs-variable,
.smalltalk .hljs-class,
.hljs-javadoc,
.ruby .hljs-string,
.django .hljs-filter .hljs-argument,
.smalltalk .hljs-localvars,
Expand Down Expand Up @@ -78,8 +77,7 @@ Brown Paper style from goldblog.com.ua (c) Zaripov Yura <yur4ik7@ukr.net>
.hljs-keyword,
.hljs-literal,
.css .hljs-id,
.hljs-phpdoc,
.hljs-dartdoc,
.hljs-doctag,
.hljs-title,
.hljs-type,
.vbscript .hljs-built_in,
Expand Down
7 changes: 2 additions & 5 deletions src/styles/color-brewer.css
View file
Expand Up @@ -80,7 +80,6 @@ Ported by Fabrício Tavares de Oliveira
}

.hljs-label,
.hljs-javadoc,
.ruby .hljs-string,
.hljs-decorator,
.hljs-filter .hljs-argument,
Expand Down Expand Up @@ -119,10 +118,8 @@ Ported by Fabrício Tavares de Oliveira
.hljs-title,
.hljs-built_in,
.css .hljs-tag,
.hljs-javadoctag,
.hljs-phpdoc,
.hljs-dartdoc,
.hljs-yardoctag,
.hljs-doctag,
.hljs-doctag,
.smalltalk .hljs-class,
.hljs-winutils,
.bash .hljs-variable,
Expand Down

0 comments on commit d9b73e9

Please sign in to comment.