From 0b94ffda40249ecc7fac9674af00c872de24ac39 Mon Sep 17 00:00:00 2001
From: Ludovic Koenig <ludovic.koenig@gmail.com>
Date: Fri, 9 Aug 2019 06:45:09 +0200
Subject: [PATCH 1/3] Prevent the highlight of Javadoc

By default, comments should keep their basic highlight with Odyssey.
Therefore, the plugin introduces the variable `g:java_ignore_javadoc`
which prevent the highlight of the Javadoc.
---
 colors/odyssey.vim | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/colors/odyssey.vim b/colors/odyssey.vim
index b886bd3..2666e68 100644
--- a/colors/odyssey.vim
+++ b/colors/odyssey.vim
@@ -283,6 +283,8 @@ call s:l(         'javaOdysseyLombok',       'Statement')
 call s:l(      'javaOdysseyEnumValue',        'Constant')
 call s:l('javaOdysseyEnumConstructor',        'Constant')
 
+let g:java_ignore_javadoc = 1
+
 " }}}
 " Ruby Highlights {{{
 

From 48dbff0ada1907f4f14fcce0d303d9f87bf3cc30 Mon Sep 17 00:00:00 2001
From: Ludovic Koenig <ludovic.koenig@gmail.com>
Date: Fri, 9 Aug 2019 21:12:02 +0200
Subject: [PATCH 2/3] Allow the highlighting of the Javadoc

It adds a mechanism that allows to trigger the highlight of the Javadoc.
In order to do so, the user must add the following to its .vimrc file
before declaring the colorscheme:

    let g:odyssey_java_javadoc = 1
    colorscheme odyssey

It must be noted that if g:odyssey_java_javadoc equals 0, the
highlighting of the Javadoc is not taken into account.
---
 colors/odyssey.vim | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/colors/odyssey.vim b/colors/odyssey.vim
index 2666e68..d4baaba 100644
--- a/colors/odyssey.vim
+++ b/colors/odyssey.vim
@@ -283,7 +283,13 @@ call s:l(         'javaOdysseyLombok',       'Statement')
 call s:l(      'javaOdysseyEnumValue',        'Constant')
 call s:l('javaOdysseyEnumConstructor',        'Constant')
 
-let g:java_ignore_javadoc = 1
+if exists('g:odyssey_java_javadoc') && g:odyssey_java_javadoc != 0
+  if exists('g:java_ignore_javadoc')
+    unlet g:java_ignore_javadoc
+  end
+else
+  let g:java_ignore_javadoc = 1
+endif
 
 " }}}
 " Ruby Highlights {{{

From 68b259b31d56b9e9f4916a8209575dfb0233a268 Mon Sep 17 00:00:00 2001
From: Ludovic Koenig <ludovic.koenig@gmail.com>
Date: Fri, 9 Aug 2019 21:23:18 +0200
Subject: [PATCH 3/3] Update the CHANGELOG.md

It introduces the changes made on the highlighting of the Javadoc.
---
 CHANGELOG.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index e9aaf6e..b88f558 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -12,6 +12,17 @@ project adheres to [Semantic Versioning].
 
 ### Changed
 
+- The highlighting of the Javadoc is prevent by default. If the user wants to
+  enable it, the following must be added to the `.vimrc` file:
+
+  ```
+  let g:odyssey_java_javadoc = 1
+  colorscheme odyssey
+  ```
+
+  *Note*: `g:odyssey_java_javadoc` must be different from `0` to enable the
+          highlighting of the Javadoc.
+
 - Change the name of some of the Java syntax group added by the plugin.
 
   + `javaOdysseyImport` becomes `javaOdysseyGetClass`,