X-Git-Url: https://git.donarmstrong.com/lilypond.git?a=blobdiff_plain;f=Documentation%2FCodingStyle.pod;h=521bf1e1266ab6b2e32d3b50cd7328c3eb8051a2;hb=a3e8a1ccfeb040b3ec18bb77841dc4ececdd65e1;hp=02b580c6025dc71b2bdc93b280d320cce0751ceb;hpb=4818fc4ce0bda7b1c44aad486d50b134b364ff78;p=lilypond.git diff --git a/Documentation/CodingStyle.pod b/Documentation/CodingStyle.pod index 02b580c602..521bf1e126 100644 --- a/Documentation/CodingStyle.pod +++ b/Documentation/CodingStyle.pod @@ -42,13 +42,20 @@ the C is a Hungarian notation postfix for $C$. See below The source is commented in the DOC++ style. Check out doc++ at http://www.zib.de/Visual/software/doc++/index.html + /* + C style comments for multiline comments. + [...] + */ + + /** short description. Long class documentation. (Hungarian postfix) */ class Class { - /** short description. + /** + short description. long description */ @@ -57,8 +64,10 @@ http://www.zib.de/Visual/software/doc++/index.html /** short memo. long doco of member() + @param description of arguments + @return Rettype */ - member(); + Rettype member(Argtype); /// memo only boring_member();