The Summary: element needs to be a single line - the other lines should go into the Description: somewhere.
Also, the params in the syntax need angle brackets round them here.
Finally could you also hard wrap the description at 72 characters please?
Actually, all the parameters and the Returns: would be best wrapped too, if that's ok.
The
Summary:
element needs to be a single line - the other lines should go into theDescription:
somewhere.Also, the params in the syntax need angle brackets round them here.
Finally could you also hard wrap the description at 72 characters please? Actually, all the parameters and the
Returns:
would be best wrapped too, if that's ok.