Skip to content

Commit fe57779

Browse files
authored
Broken internal links fixed (#242)
1 parent d49cff5 commit fe57779

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

contributor-guide/modules/ROOT/pages/design-guide/headers.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ Here are the standards for boost headers. Many of these are also reasonable guid
2020
[disc]
2121
* Header filenames should have a .hpp (lowercase) extension.
2222

23-
* Unless multiple inclusion is intended, wrap the header in `#ifndef` guards. Use a naming convention that minimizes the chance of clashes with macro names from other's code. The <<Sample Header>> uses the Boost convention of all uppercase letters, with the header name prefixed by the namespace name, followed by the relative path, and suffixed with HPP, separated by underscores. Refer also to the <<Example Header Guards>>.
23+
* Unless multiple inclusion is intended, wrap the header in `#ifndef` guards. Use a naming convention that minimizes the chance of clashes with macro names from other's code. The <<Sample>> uses the Boost convention of all uppercase letters, with the header name prefixed by the namespace name, followed by the relative path, and suffixed with HPP, separated by underscores. Refer also to the <<Example Guards>>.
2424

2525
* Wrap the header contents in a namespace to prevent global namespace pollution. The namespace approach to pollution control is strongly preferred to older approaches such as adding funny prefixes to global names. Libraries which are designed to work well with other Boost libraries should be placed in namespace `boost`.
2626

2727
* Make sure that a translation unit, consisting of just the contents of the header file, will compile successfully.
2828

29-
* Place the header file in a sub-directory to prevent conflict with identically named header files in other libraries. The parent directory is added to the compiler's include search path. Then both your code and user code specifies the sub-directory in `#include` directives. Thus the header <<Sample Header>> would be included by `#include <boost/furball.hpp>`. Including from the current file directory using `#include "furball.hpp"` syntax is discouraged.
29+
* Place the header file in a sub-directory to prevent conflict with identically named header files in other libraries. The parent directory is added to the compiler's include search path. Then both your code and user code specifies the sub-directory in `#include` directives. Thus the header <<Sample>> would be included by `#include <boost/furball.hpp>`. Including from the current file directory using `#include "furball.hpp"` syntax is discouraged.
3030

3131
* The preferred ordering for class definitions is `public` members, `protected` members, and finally `private` members.
3232

@@ -106,7 +106,7 @@ Refer to https://github.com/boostorg/beast/tree/c316c6bd3571991aeac65f0fc35fca90
106106

107107
=== Coding Style
108108

109-
The alert reader will have noticed that the <<Sample Header>> employs a certain coding style for indentation, positioning braces, commenting ending braces, and similar formatting issues. These stylistic issues are viewed as personal preferences and are not part of the Boost Header Policy.
109+
The alert reader will have noticed that the <<Sample>> header employs a certain coding style for indentation, positioning braces, commenting ending braces, and similar formatting issues. These stylistic issues are viewed as personal preferences and are not part of the Boost Header Policy.
110110

111111

112112

contributor-guide/modules/ROOT/pages/docs/documentation-components.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ applicable. link:#footnote1[(1)]:
4444
[disc]
4545
* <<Summary>>
4646
* <<Requirements>>
47-
* <<Detailed specifications>>
47+
* <<Detailed Specifications>>
4848
* <<References to the C++ Standard Library>>
4949
* <<References to the C Standard Library>>
5050

contributor-guide/modules/ROOT/pages/release-notes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Writing release notes is crucial for informing users about the changes made in t
1313

1414
Two versions of your release notes need to be prepared: one for your library's own documentation, one for a Boost history that covers all libraries added or updated in a release.
1515

16-
For the former, the Boost community does not have a strict format for your libraries' version of release notes (and some libraries refer to release notes as a _change log_ or _history_). Follow the <<_release_note_checklist>>.
16+
For the former, the Boost community does not have a strict format for your libraries' version of release notes (and some libraries refer to release notes as a _change log_ or _history_). Follow the <<Checklist>>.
1717

1818
For the latter, you will need to update a Boost history file with a succinct version of your completed release notes. These files do have a specified format, described in <<_update_boost_history>>.
1919

0 commit comments

Comments
 (0)