From ef24d66e9648eaf67df459f7e4b857f77f3fcbd2 Mon Sep 17 00:00:00 2001 From: alandefreitas Date: Fri, 24 Nov 2023 13:37:29 -0300 Subject: [PATCH] docs: JavaScript capitalization is consistent --- Doxyfile.url | 10 +++++----- doxyfile | 10 +++++----- include/mrdocs/Dom/Kind.hpp | 2 +- include/mrdocs/Dom/Object.hpp | 2 +- include/mrdocs/Support/Handlebars.hpp | 4 ++-- include/mrdocs/mrdocs.natvis | 2 +- src/lib/Support/JavaScript.cpp | 2 +- src/test/Support/{Javascript.cpp => JavaScript.cpp} | 6 +++--- 8 files changed, 19 insertions(+), 19 deletions(-) rename src/test/Support/{Javascript.cpp => JavaScript.cpp} (99%) diff --git a/Doxyfile.url b/Doxyfile.url index 5e7c511c1..b9bdf0070 100644 --- a/Doxyfile.url +++ b/Doxyfile.url @@ -299,7 +299,7 @@ OPTIMIZE_OUTPUT_SLICE = NO # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser @@ -1279,9 +1279,9 @@ HTML_TIMESTAMP = NO # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML # documentation will contain a main index with vertical navigation menus that -# are dynamically created via Javascript. If disabled, the navigation index will +# are dynamically created via JavaScript. If disabled, the navigation index will # consists of multiple levels of tabs that are statically embedded in every HTML -# page. Disable this option to support browsers that do not have Javascript, +# page. Disable this option to support browsers that do not have JavaScript, # like the Qt help browser. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. @@ -1570,7 +1570,7 @@ FORMULA_FONTSIZE = 10 FORMULA_TRANSPARENT = YES # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# https://www.mathjax.org) which uses client side Javascript for the rendering +# https://www.mathjax.org) which uses client side JavaScript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path @@ -1640,7 +1640,7 @@ MATHJAX_CODEFILE = SEARCHENGINE = YES # When the SERVER_BASED_SEARCH tag is enabled the search engine will be -# implemented using a web server instead of a web client using Javascript. There +# implemented using a web server instead of a web client using JavaScript. There # are two flavors of web server based searching depending on the EXTERNAL_SEARCH # setting. When disabled, doxygen will generate a PHP script for searching and # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing diff --git a/doxyfile b/doxyfile index b82a3ff88..8f90829aa 100644 --- a/doxyfile +++ b/doxyfile @@ -299,7 +299,7 @@ OPTIMIZE_OUTPUT_SLICE = NO # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser @@ -1279,9 +1279,9 @@ HTML_TIMESTAMP = NO # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML # documentation will contain a main index with vertical navigation menus that -# are dynamically created via Javascript. If disabled, the navigation index will +# are dynamically created via JavaScript. If disabled, the navigation index will # consists of multiple levels of tabs that are statically embedded in every HTML -# page. Disable this option to support browsers that do not have Javascript, +# page. Disable this option to support browsers that do not have JavaScript, # like the Qt help browser. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. @@ -1570,7 +1570,7 @@ FORMULA_FONTSIZE = 10 FORMULA_TRANSPARENT = YES # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# https://www.mathjax.org) which uses client side Javascript for the rendering +# https://www.mathjax.org) which uses client side JavaScript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path @@ -1640,7 +1640,7 @@ MATHJAX_CODEFILE = SEARCHENGINE = YES # When the SERVER_BASED_SEARCH tag is enabled the search engine will be -# implemented using a web server instead of a web client using Javascript. There +# implemented using a web server instead of a web client using JavaScript. There # are two flavors of web server based searching depending on the EXTERNAL_SEARCH # setting. When disabled, doxygen will generate a PHP script for searching and # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing diff --git a/include/mrdocs/Dom/Kind.hpp b/include/mrdocs/Dom/Kind.hpp index f89b2f08d..2087305cc 100644 --- a/include/mrdocs/Dom/Kind.hpp +++ b/include/mrdocs/Dom/Kind.hpp @@ -54,7 +54,7 @@ namespace dom { These reference types are modeled after JavaScript "Objects". All non-primitive types (Object types) - are derived from Object in Javascript. This means + are derived from Object in JavaScript. This means types such as Array and Function represent a relevant selection of built-in types that would derive from Object in JavaScript. diff --git a/include/mrdocs/Dom/Object.hpp b/include/mrdocs/Dom/Object.hpp index 00d86b07a..a94159921 100644 --- a/include/mrdocs/Dom/Object.hpp +++ b/include/mrdocs/Dom/Object.hpp @@ -40,7 +40,7 @@ class Value; These reference types are modeled after JavaScript "Objects". All non-primitive types (Object types) - are derived from Object in Javascript. This means + are derived from Object in JavaScript. This means types such as Array and Function represent a relevant selection of built-in types that would derive from Object in JavaScript. diff --git a/include/mrdocs/Support/Handlebars.hpp b/include/mrdocs/Support/Handlebars.hpp index ad43e0b8a..427cdc6e5 100644 --- a/include/mrdocs/Support/Handlebars.hpp +++ b/include/mrdocs/Support/Handlebars.hpp @@ -1057,7 +1057,7 @@ registerAntoraHelpers(Handlebars& hbs); first argument is the value of the helper. The helper names are inspired by the default string functions provided - in multiple programming languages, such as Python and Javascript, + in multiple programming languages, such as Python and JavaScript, for their default string types. The individual helpers are defined as an implementation detail and @@ -1079,7 +1079,7 @@ registerStringHelpers(Handlebars& hbs); The helper names are inspired by the default functions provided in multiple programming languages for dictionaries, objects, and arrays, - such as Python and Javascript, for their default types. + such as Python and JavaScript, for their default types. The individual helpers are defined as an implementation detail and cannot be registered individually. diff --git a/include/mrdocs/mrdocs.natvis b/include/mrdocs/mrdocs.natvis index 19a4374df..33385b401 100644 --- a/include/mrdocs/mrdocs.natvis +++ b/include/mrdocs/mrdocs.natvis @@ -151,7 +151,7 @@ - + [ js::Access ] diff --git a/src/lib/Support/JavaScript.cpp b/src/lib/Support/JavaScript.cpp index 0cd67b0bb..4bde4234b 100644 --- a/src/lib/Support/JavaScript.cpp +++ b/src/lib/Support/JavaScript.cpp @@ -851,7 +851,7 @@ class JSArrayImpl : public dom::ArrayImpl size_type size() const override; }; -// A Javascript function defined in the scope as a dom::Function +// A JavaScript function defined in the scope as a dom::Function class JSFunctionImpl : public dom::FunctionImpl { Access A_; diff --git a/src/test/Support/Javascript.cpp b/src/test/Support/JavaScript.cpp similarity index 99% rename from src/test/Support/Javascript.cpp rename to src/test/Support/JavaScript.cpp index 4970ab6cd..61b96254f 100644 --- a/src/test/Support/Javascript.cpp +++ b/src/test/Support/JavaScript.cpp @@ -16,7 +16,7 @@ namespace clang { namespace mrdocs { namespace js { -struct Javascript_test +struct JavaScript_test { void test_context() @@ -900,8 +900,8 @@ struct Javascript_test }; TEST_SUITE( - Javascript_test, - "clang.mrdocs.Javascript"); + JavaScript_test, + "clang.mrdocs.JavaScript"); } // js } // mrdocs