PageLayout

From Crypto++ Wiki
Jump to: navigation, search

The pages describing Crypto++'s algorithms should have a similar look and feel. This page will attempt to decide on such a design, and should preferably result in the Wiki pages being adjusted to the agreed upon design. Please see also How To Submit Sample Code and Projects.

The tentative design is shown below:

Construction

Describe the classes and their constructors

Usage

Describe the methods involved when using the algorithm in question.

Remarks

Describe any remarks or comments worth mentioning regarding the algorithm in question. This section is particularly aimed at usage information that is not evidently clear from the previous section. The discussion group is an excellent place to observe the pitfalls people have experienced.

Examples

Illustrate the use of the algorithm. Use <pre> and </pre> tags to surround code until we find a library that can display C/C++ code in a decent fashion.

Downloadable Samples

Links to compilable sample programs.