docs/support/doxygen/client_api.doxy.in - kudu - Git at Google

 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
 # distributed with this work for additional information
 # regarding copyright ownership.  The ASF licenses this file
 # to you under the Apache License, Version 2.0 (the
 # "License"); you may not use this file except in compliance
 # with the License.  You may obtain a copy of the License at
 #
 #   http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
 # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
 #

 #
 # This file describes the settings to be used by doxygen (www.doxygen.org)
 # to generate Kudu C++ client API documentation.  Current contents of the file
 # is based on template generated by doxygen v1.8.10.  After the template file
 # was generated, all parameters with default values were removed
 # along with corresponding comments.  Only relevant parameters
 # with custom settings are left.
 #

 # Here we generate documentation for the Kudu C++ client API.
 PROJECT_NAME           = "Kudu C++ client API"

 # Current empty value reflects the fact that working directory where
 # doxygen runs is the location where necessary directory structure
 # with header files resides.
 INPUT                  =

 # Due to current layout of the header files to process, the recursive scan
 # for files is turned on.
 RECURSIVE              = YES

 # We exclude some of the sources under the top-level client hierarchy
 # which we don't want to process since there isn't doxygen documentation
 # in those anyway.
 EXCLUDE                = @DOXY_CLIENT_API_EXCLUDE@

 # We add information about the Kudu version the documentation is generated for.
 # NOTE: this tag requires GENERATE_HTML enabled.
 HTML_FOOTER            = @DOXY_CLIENT_API_FOOTER@

 # Current value is set by one of make targets while generating
 # the Kudu C++ client API documentation.
 OUTPUT_DIRECTORY       = @DOXY_CLIENT_API_OUTDIR@

 # Whether to treat warnings as errors. It makes sense to be more strict while
 # generating documentation targeted for broader audience (e.g., for releases).
 WARN_AS_ERROR          = @DOXY_CLIENT_API_WARN_AS_ERROR@

 # Do not be too verbose: QUIET is set to YES, so informational messages are off.
 QUIET                  = YES

 # We want to have warnings for functions/methods which are documented,
 # but have no documentation for their parameters or the return value.
 WARN_NO_PARAMDOC       = YES

 # As for now, documentation in LaTeX format is not needed.
 GENERATE_LATEX         = NO

 # Do not output warnings on undocumented friend classes/structs/unions.
 HIDE_FRIEND_COMPOUNDS  = YES

 # Copy the first member's documentation to the rest in the group if they aren't
 # documented.
 DISTRIBUTE_GROUP_DOC   = YES
	#
	# Licensed to the Apache Software Foundation (ASF) under one
	# or more contributor license agreements. See the NOTICE file
	# distributed with this work for additional information
	# regarding copyright ownership. The ASF licenses this file
	# to you under the Apache License, Version 2.0 (the
	# "License"); you may not use this file except in compliance
	# with the License. You may obtain a copy of the License at
	#
	# http://www.apache.org/licenses/LICENSE-2.0
	#
	# Unless required by applicable law or agreed to in writing,
	# software distributed under the License is distributed on an
	# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	# KIND, either express or implied. See the License for the
	# specific language governing permissions and limitations
	# under the License.
	#

	#
	# This file describes the settings to be used by doxygen (www.doxygen.org)
	# to generate Kudu C++ client API documentation. Current contents of the file
	# is based on template generated by doxygen v1.8.10. After the template file
	# was generated, all parameters with default values were removed
	# along with corresponding comments. Only relevant parameters
	# with custom settings are left.
	#

	# Here we generate documentation for the Kudu C++ client API.
	PROJECT_NAME = "Kudu C++ client API"

	# Current empty value reflects the fact that working directory where
	# doxygen runs is the location where necessary directory structure
	# with header files resides.
	INPUT =

	# Due to current layout of the header files to process, the recursive scan
	# for files is turned on.
	RECURSIVE = YES

	# We exclude some of the sources under the top-level client hierarchy
	# which we don't want to process since there isn't doxygen documentation
	# in those anyway.
	EXCLUDE = @DOXY_CLIENT_API_EXCLUDE@

	# We add information about the Kudu version the documentation is generated for.
	# NOTE: this tag requires GENERATE_HTML enabled.
	HTML_FOOTER = @DOXY_CLIENT_API_FOOTER@

	# Current value is set by one of make targets while generating
	# the Kudu C++ client API documentation.
	OUTPUT_DIRECTORY = @DOXY_CLIENT_API_OUTDIR@

	# Whether to treat warnings as errors. It makes sense to be more strict while
	# generating documentation targeted for broader audience (e.g., for releases).
	WARN_AS_ERROR = @DOXY_CLIENT_API_WARN_AS_ERROR@

	# Do not be too verbose: QUIET is set to YES, so informational messages are off.
	QUIET = YES

	# We want to have warnings for functions/methods which are documented,
	# but have no documentation for their parameters or the return value.
	WARN_NO_PARAMDOC = YES

	# As for now, documentation in LaTeX format is not needed.
	GENERATE_LATEX = NO

	# Do not output warnings on undocumented friend classes/structs/unions.
	HIDE_FRIEND_COMPOUNDS = YES

	# Copy the first member's documentation to the rest in the group if they aren't
	# documented.
	DISTRIBUTE_GROUP_DOC = YES