boost/interprocess
2
0
Fork 0
mirror of https://github.com/boostorg/interprocess.git synced 2026-01-19 04:12:13 +00:00
Code Issues Projects Releases Wiki Activity

Fix misformatted code samples in the documentation

Browse Source 
The current examples look strange since the C++-style comments result in the rest of the line being completely commented-out. This commit changes the way those parameters are documented to make them consistent with the rest of the documentation.

Note that I was unable to test this change because I wasn't able to generate the Boost documentation locally.
This commit is contained in:
Louis Dionne
2017-07-03 16:18:22 -07:00
committed by GitHub
parent 6f5944f63c
commit b98796e11a
1 changed files with 11 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/interprocess.qbk
View File

@@ -3350,7 +3350,9 @@ To use a managed mapped file, you must include the following header:
// file to implement managed features.
//!! If anything fails, throws interprocess_exception
//
managed_mapped_file mfile (create_only, "MyMappedFile", //Mapped file name 65536); //Mapped file size
managed_mapped_file mfile ( create_only
, "MyMappedFile" //Mapped file name
, 65536); //Mapped file size
[c++]
//1. Opens a file
@@ -3361,7 +3363,10 @@ To use a managed mapped file, you must include the following header:
// to implement managed features.
//!! If anything fails, throws interprocess_exception
//
managed_mapped_file mfile (open_only, "MyMappedFile"); //Mapped file name[c++]
managed_mapped_file mfile ( open_only
, "MyMappedFile"); //Mapped file name
[c++]
//1. If the file was previously created
// equivalent to "open_only".
@@ -3369,7 +3374,10 @@ To use a managed mapped file, you must include the following header:
//
//!! If anything fails, throws interprocess_exception
//
managed_mapped_file mfile (open_or_create, "MyMappedFile", //Mapped file name 65536); //Mapped file size
managed_mapped_file mfile (open_or_create
, "MyMappedFile" //Mapped file name
, 65536); //Mapped file size
When the `managed_mapped_file` object is destroyed, the file is
automatically unmapped, and all the resources are freed. To remove
the file from the filesystem you could use standard C `std::remove`