cppalliance / mrdocs

MrDocs: A Clang/LLVM tool for building reference documentation from C++ code and javadoc comments.
https://mrdocs.com
Other
81 stars 17 forks source link

Implicit special member functions #187

Open sdkrystian opened 1 year ago

sdkrystian commented 1 year ago

We need to decide whether to extract implicitly declared special member functions. On one hand, extracting such functions could introduce a lot of "noise" to the documentation (since most classes would have them). On the other hand, a class could for example contain a private non-copyable non-static data member, which would make the class non-copyable but not be apparent from the public interface.

alandefreitas commented 5 months ago

What does cppreference do? It seems reasonable to document them because they're part of the API. They're just 5 functions anyway, so it shouldn't be much noise in the documentation.