Skip to content

Commit

Permalink
Prepare for 4.0.1 release. (#818)
Browse files Browse the repository at this point in the history
* Change lib version from 4.0.0 to 4.0.1.
* Update to doxygen config for better content generation.
  • Loading branch information
ihsandemir authored Feb 24, 2021
1 parent 57ece8e commit 027d56d
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
cmake_minimum_required(VERSION 3.10)

project(hazelcast-cpp-client
VERSION 4.0.0
VERSION 4.0.1
DESCRIPTION "Hazelcast C++ Client"
HOMEPAGE_URL https://hazelcast.org/clients/cplusplus/
LANGUAGES CXX)
Expand Down
22 changes: 11 additions & 11 deletions Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,14 @@ PROJECT_NUMBER =
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.

PROJECT_BRIEF =
PROJECT_BRIEF = Hazelcast C++ Client Library

# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
# the documentation. The maximum height of the logo should not exceed 55 pixels
# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
# to the output directory.

PROJECT_LOGO =
PROJECT_LOGO = logo/IMDG_blue_logo_square_RGB-dark_200px.png

# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
Expand All @@ -68,7 +68,7 @@ OUTPUT_DIRECTORY = docs
# performance problems for the file system.
# The default value is: NO.

CREATE_SUBDIRS = NO
CREATE_SUBDIRS = YES

# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
Expand Down Expand Up @@ -296,7 +296,7 @@ AUTOLINK_SUPPORT = YES
# diagrams that involve STL classes more complete and accurate.
# The default value is: NO.

BUILTIN_STL_SUPPORT = NO
BUILTIN_STL_SUPPORT = YES

# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
Expand Down Expand Up @@ -733,7 +733,7 @@ WARN_LOGFILE =
# spaces.
# Note: If this tag is empty the current directory is searched.

INPUT = ./hazelcast/
INPUT = ./hazelcast/ README.md

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Expand Down Expand Up @@ -815,7 +815,7 @@ EXCLUDE_SYMBOLS = *::impl::* \
# that contain example code fragments that are included (see the \include
# command).

EXAMPLE_PATH =
EXAMPLE_PATH = ./examples

# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
Expand All @@ -829,7 +829,7 @@ EXAMPLE_PATTERNS =
# irrespective of the value of the RECURSIVE tag.
# The default value is: NO.

EXAMPLE_RECURSIVE = NO
EXAMPLE_RECURSIVE = YES

# The IMAGE_PATH tag can be used to specify one or more files or directories
# that contain images that are to be included in the documentation (see the
Expand Down Expand Up @@ -883,7 +883,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.

USE_MDFILE_AS_MAINPAGE =
USE_MDFILE_AS_MAINPAGE = README.md

#---------------------------------------------------------------------------
# Configuration options related to source browsing
Expand All @@ -896,13 +896,13 @@ USE_MDFILE_AS_MAINPAGE =
# also VERBATIM_HEADERS is set to NO.
# The default value is: NO.

SOURCE_BROWSER = NO
SOURCE_BROWSER = YES

# Setting the INLINE_SOURCES tag to YES will include the body of functions,
# classes and enums directly into the documentation.
# The default value is: NO.

INLINE_SOURCES = NO
INLINE_SOURCES = YES

# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
# special comment blocks from generated source code fragments. Normal C, C++ and
Expand Down Expand Up @@ -1356,7 +1356,7 @@ DISABLE_INDEX = NO
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.

GENERATE_TREEVIEW = NO
GENERATE_TREEVIEW = YES

# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
# doxygen will group on one line in the generated HTML documentation.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The library can be installed using package managers ([Conan](Reference_Manual.md

## Documentation

You can find the detailed documentation at [Reference Manual](Reference_Manual.md).
You can find the detailed documentation at the [documentation site](https://hazelcast.github.io/hazelcast-cpp-client/) and the [Reference Manual](Reference_Manual.md).

## License

Expand Down
14 changes: 7 additions & 7 deletions Reference_Manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ on how to use conan package manager with your application. In summary,
- You need to put the following lines to your `conanfile.txt`:
```
[requires]
hazelcast-cpp-client/4.0.0
hazelcast-cpp-client/4.0.1
[generators]
cmake
Expand Down Expand Up @@ -199,23 +199,23 @@ Follow the instructions for your platform:
* [Windows](#1123-windows-users)

#### 1.1.2.3. Linux and MacOS Users
Here is how you download and extract version 4.0.0 using the **curl** command:
Here is how you download and extract version 4.0.1 using the **curl** command:
```sh
curl -Lo hazelcast-cpp-client-4.0.0.tar.gz https://github.com/hazelcast/hazelcast-cpp-client/archive/v4.0.0.tar.gz
tar xzf hazelcast-cpp-client-4.0.0.tar.gz
curl -Lo hazelcast-cpp-client-4.0.1.tar.gz https://github.com/hazelcast/hazelcast-cpp-client/archive/v4.0.1.tar.gz
tar xzf hazelcast-cpp-client-4.0.1.tar.gz
```

Alternatively, you may clone the repository and checkout a specific version:
```sh
git clone https://github.com/hazelcast/hazelcast-cpp-client.git
cd hazelcast-cpp-client
git checkout v4.0.0
git checkout v4.0.1
```

Once you are in the source directory of the Hazelcast C++ client library,
create and change into a new directory:
```sh
cd hazelcast-cpp-client-4.0.0
cd hazelcast-cpp-client-4.0.1
mkdir build
cd build
```
Expand All @@ -240,7 +240,7 @@ Download and extract the release archive from the
Open a `cmd` window and change into the folder where you extracted the contents of the release archive.
Then create and change into a new directory:
```bat
cd hazelcast-cpp-client-4.0.0
cd hazelcast-cpp-client-4.0.1
mkdir build
cd build
```
Expand Down
2 changes: 1 addition & 1 deletion examples/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
cmake_minimum_required (VERSION 3.10)

project (hazelcast-cpp-client-examples
VERSION 4.0.0
VERSION 4.0.1
DESCRIPTION "Hazelcast C++ Client Code Examples"
HOMEPAGE_URL https://hazelcast.org/clients/cplusplus/
LANGUAGES CXX)
Expand Down
Binary file added logo/IMDG_blue_logo_square_RGB-dark_200px.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 027d56d

Please sign in to comment.