<!--*-markdown-*-

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
nspecific language governing permissions and limitations
under the License.

-->

# API documentation

`api`: User API documentation is generated automatically from [doxygen](http://www.doxygen.org)
comments in public header files.  You can use the `@internal` tag to mark items
that should be hidden in the user API docs.

`api_dev` includes everything in `api`, plus anything marked `@internal`, plus
doc comments from private headers and implementation files in the `src`
directory. It is a cheap-and-cheerful code-browser for developers.

Please include doc comments for everything in public header files. Use your
discretion as to when it is useful in private implementation files.