¡@

Home 

c++ Programming Glossary: documenting

How to automatically register a class on creation

http://stackoverflow.com/questions/10332725/how-to-automatically-register-a-class-on-creation

call register I'm looking for ways to prevent that besides documenting this which I will anyway . PS This is just an example I'm not..

Why do we need to mark functions as constexpr?

http://stackoverflow.com/questions/14472359/why-do-we-need-to-mark-functions-as-constexpr

issue frustrating your rebuilding. By using constexpr I'm documenting that client code can have a reasonable expectation of the function..

How to parse text for a DSL at compile time?

http://stackoverflow.com/questions/17783393/how-to-parse-text-for-a-dsl-at-compile-time

worth posting as the potential answers are really worth documenting. c dsl share improve this question Disclaimer I know nothing..

Header file best practices for typedefs

http://stackoverflow.com/questions/2356548/header-file-best-practices-for-typedefs

clearer I believe to consistently call this FooListPtr and documenting the naming convention that Ptr means shared_ptr and List means..

Deriving an abstract class from concrete class

http://stackoverflow.com/questions/310408/deriving-an-abstract-class-from-concrete-class

is safe. Possibly you will meet the last requirement by documenting that DerivedTomatoes must call Berry Juice . If so consider..

C++ meta-programming doxygen documentation

http://stackoverflow.com/questions/3435225/c-meta-programming-doxygen-documentation

meta programming doxygen documentation I am documenting some code which uses meta programming heavily for example template..

NetUIHWND and DirectUIHWND

http://stackoverflow.com/questions/4089196/netuihwnd-and-directuihwnd

version of Windows. Which I think was the point of not documenting it they need something they don't have to keep backwards compatible..

What is the purpose of __in __out __in_opt __allowed(), how do they work? Should I use similar constructs in my own code?

http://stackoverflow.com/questions/4239809/what-is-the-purpose-of-in-out-in-opt-allowed-how-do-they-work-should

without any functionality If so I can see the advantage to documenting the code in line like this. With something like doxygen you..

How does the Comma Operator work

http://stackoverflow.com/questions/54142/how-does-the-comma-operator-work

up equaling b or c Yes I know this is easy to test just documenting on here for someone to find the answer quickly. Update This..

C++ multi-dimensional data handling

http://stackoverflow.com/questions/606004/c-multi-dimensional-data-handling

do. But in the end the code was a mess and I wasn't happy documenting it. Lesson learned again and again and again... share improve..

How to use utf8 character arrays in c++?

http://stackoverflow.com/questions/6072342/how-to-use-utf8-character-arrays-in-c

from the source file and achieve conformance simply be documenting that the source file must be in UTF 8 for these features to..

casting unused return values to void

http://stackoverflow.com/questions/689677/casting-unused-return-values-to-void

better than commenting an unused return value since self documenting code is better than comments. Personally I'll turn these warnings..

Dynamic dispatching of template functions?

http://stackoverflow.com/questions/7089284/dynamic-dispatching-of-template-functions

handle #undef PASTE #undef LIMIT Better find good self documenting names for LIMIT wouldn't hurt for PASTE either and limit the..

How to be able to extract comments from inside a function in doxygen?

http://stackoverflow.com/questions/758045/how-to-be-able-to-extract-comments-from-inside-a-function-in-doxygen

C++ dll and C# call

http://stackoverflow.com/questions/7872392/c-dll-and-c-sharp-call

strOut The __out decorator has no real effect other than documenting that you want to modify the buffer pointed to by strOut and..

2 ways of passing by reference in C++? [duplicate]

http://stackoverflow.com/questions/9152283/2-ways-of-passing-by-reference-in-c

With explicitly deleted member functions in C++11, is it still worthwhile to inherit from a noncopyable base class?

http://stackoverflow.com/questions/9458741/with-explicitly-deleted-member-functions-in-c11-is-it-still-worthwhile-to-inh

more thought. Yes it's called noncopyable so it is self documenting. But if you've never seen it before it raises questions. Why..