p12tic / cppreference-doc Goto Github PK

When compared to the Qt documentation, cppreference appears to have really large fonts. And the problem is exacerbated with current Qt5 versions which lack QtWebKit, so one can't even scale down the main text: only the caption scales.

The fonts appear correct in the official QCH book release 20170409, and are already too large in the 20181028 release. And this problem remains with the releases made from this repo.

See the following screenshots for comparison between Qt docs and C++ docs.

QString docs @ Qt5 Assistant:

std::string docs @ Qt5 Assistant:

Even if I open in Qt4 Assistant built with QtWebKit support, the fonts are too large, although the content is easier to scale (and formatting is less broken, but this is another issue, #47).

std::string docs @ Qt4 Assistant:

<function name="towlower" link="c/string/wide/tolower"/>
<function name="towupper" link="c/string/wide/toupper"/>

should be:

<function name="towlower" link="c/string/wide/towlower"/>
<function name="towupper" link="c/string/wide/towupper"/>

It's really nice that pages like https://en.cppreference.com/w/cpp/language/constexpr include information about many versions of the language! That said, if one happens to just be interested in a specific version of the language, then the inapplicable information can be a bit noisy and distracting. For example, quite often all I want to know is "how does feature X work in C++17?", not "what was the detailed evolution of feature X over the complete history of C++?".

So maybe a useful feature could be to have a button somewhere near the top of the page, that lets the user select a language version. The effect of selecting a language version would be that text inapplicable to that standard version would be omitted. For example, if you select C++17, then obsolete rules that only applied "(until C++14)" or "(until C++17)" would not be shown.

What do you think? :)

As of August 1, 2023, there have been attacks on this site with posts saying Rust is the best and links changed to Rust's Wikipedia.
Once this has been corrected, it appears to have been fixed, but the number of attacks has increased since the beginning of this year, so I decided to report it and list it on the issue.

the offline html help file is empte

When I search std::move from docs online, it gives me a piece of code

#include <iostream>
#include <utility>
#include <vector>
#include <string>

int main()
{
    std::string str = "Hello";
    std::vector<std::string> v;

    // uses the push_back(const T&) overload, which means 
    // we'll incur the cost of copying str
    v.push_back(str);
    std::cout << "After copy, str is \"" << str << "\"\n";

    // uses the rvalue reference push_back(T&&) overload, 
    // which means no strings will be copied; instead, the contents
    // of str will be moved into the vector.  This is less
    // expensive, but also means str might now be empty.
    v.push_back(std::move(str));
    std::cout << "After move, str is \"" << str << "\"\n";

    std::cout << "The contents of the vector are \"" << v[0]
                                         << "\", \"" << v[1] << "\"\n";

    // string move assignment operator is often implemented as swap,
    // in this case, the moved-from object is NOT empty
    std::string str2 = "Good-bye";
    std::cout << "Before move from str2, str2 = '" << str2 << "'\n";
    v[0] = std::move(str2);
    std::cout << "After move from str2, str2 = '" << str2 << "'\n";
}

The docs give the output

After copy, str is "Hello"
After move, str is ""
The contents of the vector are "Hello", "Hello"
Before move from str2, str2 = 'Good-bye'
After move from str2, str2 = 'Hello'

But when using the clang compiler which the website offers, the output is

After copy, str is "Hello"
After move, str is ""
The contents of the vector are "Hello", "Hello"
Before move from str2, str2 = 'Good-bye'
After move from str2, str2 = ''

So I am confused which one is the correct answer.

The offline archive is old and outdated.

Can you please update the offline archive ( HTML Book )? I tried to contact the website with their mail but I didn't get any respond...

it's on the website, for c-only programmers, is it possible to manpage or devhelp to all those C information(e.g. no cstdio but stdio.h) along with c-only examples?

The QCH file/database is missing all the files from the common/ folder, only the en/ folder is packaged. This folder is quite important as it contains some Javascript, but also the CSS of the website and a bunch of UML diagram referenced in various pages.

I'm displaying the qch content in my own application (using my own Qt interface), and everything looks terrible as I can't retrieve the required common/ files from the qch file.

The following classes are not fully described in the XML file. This breaks search functionality.
std::valarray, std::slice, std::gslice, std::slice_array, std::gslice_array, std::mask_array, std::indirect_array.

e.g. the concepts from std:: and std::ranges; all the view adaptors...

I could make PRs for this, but I have no clue how. Is there documentation somewhere on how to contribute these?

I'm probably misunderstanding something, but shouldn't https://github.com/p12tic/cppreference-doc/blob/master/index-functions-cpp.xml#L2679 link to the new NAN.2 page?

I did a Lua script to extract the code examples and test then here robertoraggi/cplusplus#314 to test it's independent parser https://github.com/robertoraggi/cplusplus and other parsers as well like g++ and clang .

Around 5% of the examples fail (some are due to missing include files or the libstdc++ installed on my Ubuntu 18.04).

If this project doesn't have a script to test the code examples you can use/adapt it .

This is probably the same as #78, but I'm not sure.

The tag-files seem to be missing multiple entries. I'm specifically looking at static_assert. It shows up in link-map.xml yet not in any of the .tag files. I tried adding it to index-functions-cpp.xml, yet that has no effect.

<class name="std::regex_error" link="cpp/regex_error">

Should be:

<class name="std::regex_error" link="cpp/regex/regex_error">

This is a follow-up to the post on the website:

Where would i start looking to implement a simple CSV file along these lines?

Anki renders the cards as HTML in the interface, so i have essentially spammed the
default card stylesheet with the cppreference stylesheet to keep the page formatting.
It seems that every section/linkable keyword correlates to an 'answer' or concept worth
remembering. The hardest part is of course generating questions. My idea (at least for
a first approximation) was to generate the card/question list from the section/keyword
list + context in tree. Imagine each section as a flashcard. for example:
Q: What is: Operator Overloading (C++ Language, Expressions)

In Windows NAN.html and nan.html repeat.
In
html_book_20140827.zip\reference\en\c\numeric\math\
and
html_book_20140827.zip\reference\en\cpp\numeric\math
both have NAN.html and nan.html.It can't stay in windows.
In cppreference-doc-20140827.zip\cppreference-doc-20140827\reference\en.cppreference.com\w\c\numeric\math
and
cppreference-doc-20140827.zip\cppreference-doc-20140827\reference\en.cppreference.com\w\cpp\numeric\math
also have this question.

On windows 7 unpacking html book archieve leads to error because of * symbol in some files path, for example in operator*.html

I can't reliably access cppreference.com; I've consistently been getting 503 errors. And when I don't, the site takes a very long time (over a minute) to load a page.

Unfortunately QtCreator has a bug that leads to the CSS files in the .qch file being ignored. The documentation is thus unusable on QtCreator.

QtAssistant displays everything correctly.

Hello at all,
reading https://en.cppreference.com/w/cpp/iterator/iterator_tags,
i wonder, the inheritance structure of should forward_iterator_tag is correct herein.

Is the forward_iterator_tag not also inherit from sruct output_iterator_tag ?

it says
struct forward_iterator_tag : public input_iterator_tag {}; // (4)

Were do I find a decise manual howto properly write my own iterators for my own classes.
Yours,
Frank.Haferkorn

On the discussion page this was discussed and said that it is possible for logged-in users, but it is not production ready. T. Canens had written some notes about the shortcomings here.

On the main page: https://en.cppreference.com/w/ (but not on https://en.cppreference.com/w/cpp) there is standard revision option in the header, but it seems not to do anything (Firefox 122.)

It works on any other page than the main page. Marking this as closed.

(maybe)

<class name="std::err_c" link="cpp/error/err_c">

should be:

<class name="std::errc" link="cpp/error/errc">

I am embedding pages from cppreference in an iframe from a web app (the jupyter notebook), which fetches the resources from cppreference based on some tag file.

The problem is that when the connection to jupyter is https, the CORS setting disallow loading content from an insecure source. Would it be possible for cppreference to be served over https?

utility/move

The following results are generated from Apple Clang 7 on Mac OS X 10.11. And I believe the output of the last line would never be 'Hello', shown in the above page.

After copy, str is "Hello"
After move, str is ""
The contents of the vector are "Hello", "Hello"
Before move from str2, str2 = 'Good-bye'
After move from str2, str2 = **''**

The following output from a doxygen source listing:

#include <vector>

Does not link to http://en.cppreference.com/w/cpp/header/vector

When using QCH files together with Clang on OSX it does not find any keywords using F1. The reason for that is libc++ adds extra prefix to the namespace.

So std::basic_ifstream::is_open method is resolved and looked up in Qt Creator as std::__LIBCPP_ABI_VERSION::basic_ifstream::is_open.

A simple trivial workaround is to generate libc++ keyword version as a post-process step of QCH generation using following SQL (sqlite3) script:

 insert into IndexTable (Name, Identifier, NamespaceId, FileId, Anchor) select Name, replace(Identifier, 'std::', 'std::___LIBCPP_ABI_VERSION::'), NamespaceId, FileId, Anchor from IndexTable;

Or add this to some pre-process Python script.

Hello, i wanted to get the offline version of the archive, but it's unformated.
I cannot read anything out of it, it doesn't look anything like the website. I believe it didn't import it correctly.

link: http://en.cppreference.com/w/File:cppreference-doc-20161029.zip

OS: Kubuntu 17.x x64
I've installed DevHelp through flatpak,
then I proceded to install the cppreference package:
sudo apt install cppreference-doc-en-html
then I start DevHelp, which finds as you can see, but it can't open it, because not existing files :/

(AND also I noticed that the package is old (20170409-1).

How to make it work?
It's possible to get an updated package?

A tag for std::ios_base::openmode seems to be missing in the generated Doxygen tag files. Is there a way to fix that?

Need to specify standard version where this feature was introduced

当知耻

In this repo the headers for C++ are present. Is a similar effort available for the C headers (eg, string.h, etc) available? I notice those headers are described on cppreference so I was curious where I might find those. Thanks!

This entry is missing:

• static_assert - http://en.cppreference.com/w/cpp/keyword/static_assert

Hello, maintainers.

According to README.md, this project is a source package of cppreference.com.

Since the cppreference.com is a Wiki website, there is an "Edit" option in the menu bar, which can let us edit the pages directly.

Therefore, I wonder:

1. Is it an official project for cppreference.com?

2. If we gonna edit the content of cppreference.com, where should we contribute to?

3. What is the purpose of maintaining this project?

I haven't debugged exactly what the paths are in the supplied QCH files, but they are wrong. :-)

Pressing F1 on an arbitrary element in QtCreator gives me "Error loading: qthelp://cppreference.com.cppreference-doc-en-cpp/cpp/en/cpp.html".

A working file is supplied here: http://cristianadam.blogspot.no/2014/06/qt-creator-help-is-on-way.html

No sure if this is the place to report it, I apologize if so.
The qch file hosted at http://en.cppreference.com/w/Cppreference:Archives isn't working properly (February and March of 2014), May 2013 version is fine.

The QtCreator context search finds keywords but whatever it is found, the links are just pointing to the start page. The same happens in Qt Assistant.

I could generate a qch myself to testing, but I'm not sure if the script works on Windows.

The styling of the latest qch book (20170409.tar.gz) is missing under Qt Creator 4.2 and 4.3.

Please, take a look at the attached screenshot:

Could you add new format(zim) of offline archive?
You can use zimwriterfs to pack those html files.
I think it is a good idea.
Because we can read this doc in many devices(for example android) only 1 file(use kiwix or kiwix-serve).
And we can Full text search.
Also you can let kiwix help you build this doc.I think they will be happy to help.
zimwriterfs is a console tool to create ZIM (http://www.openzim.org)
files from a localy stored directory containing a "self-sufficient"
HTML content (with pictures, javascript, stylesheets). The result will
contain all the files of the local directory compressed and merged in
the ZIM file. Nothing more, nothing less. The generated file can be
open with a ZIM reader, Kiwix (http://www.kiwix.org) for example, but
you have other one (http://openzim.org/wiki/ZIM_Readers).
https://sourceforge.net/p/kiwix/other/ci/master/tree/zimwriterfs/