Click here to Skip to main content

Welcome to the Lounge


For lazing about and discussing anything in a software developer's life that takes your fancy.
The Lounge is rated PG. If you're about to post something you wouldn't want your kid sister to read then don't post it. No flame wars, no abusive conduct and please don't post ads.

Technical discussions are welcome, but if you need specific help please use the programming forums.

GeneralDoxygen considered harmful PinmemberYvesDaoust8-Oct-12 0:54 
For the Nth time in my developer's career, I came across an API which was documented using Doxygen. (For the sake of mercy, I won't name it.)
As usual, all you are entitled to is a very terse introductory page, accompanied by the bloody, endless, uninformative Class Reference. As a bonus, you also get that wonderfully useless File List.
This way to document software drives me mad. It forces you to scan the whole API before you know if the functionality suits your needs, and gives you no hint on the philosophy of the stuff. This turns the discovery of otherwise valuable products into a painful guesswork and causes the learning curve to raise vertically.
I put most of the blame on Doxygen, because it gives programmers a false feeling that they did document their API, and that they did it in a "lush" way. I put the blame on Doxygen because of the poor presentation style it spreads and legitimizes, which favors form over content.
GeneralRe: Doxygen considered harmful PinmemberNagy Vilmos8-Oct-12 1:04 
GeneralRe: Doxygen considered harmful PinmvpEspen Harlinn8-Oct-12 1:14 
GeneralRe: Doxygen considered harmful PinmemberYvesDaoust8-Oct-12 1:20 
GeneralEhhrmm .... PinmvpEspen Harlinn8-Oct-12 2:11 
GeneralRe: Ehhrmm .... PinmemberMark Wallace8-Oct-12 2:35 
GeneralRe: Ehhrmm .... PinmemberYvesDaoust8-Oct-12 2:49 
GeneralRe: Ehhrmm .... PinmvpEspen Harlinn8-Oct-12 2:54 
GeneralRe: Ehhrmm .... PinmemberMark Wallace8-Oct-12 3:08 
GeneralRe: Ehhrmm .... PinmvpEspen Harlinn8-Oct-12 3:19 
GeneralRe: Ehhrmm .... PinmemberYvesDaoust8-Oct-12 2:48 
GeneralRe: Ehhrmm .... PinmvpEspen Harlinn8-Oct-12 2:55 
GeneralRe: Ehhrmm .... PinmemberYvesDaoust8-Oct-12 2:59 
GeneralRe: Ehhrmm .... PinmvpEspen Harlinn8-Oct-12 3:22 
GeneralRe: Doxygen considered harmful PinmemberChris Quinn8-Oct-12 1:15 
GeneralRe: Doxygen considered harmful PinmemberYvesDaoust8-Oct-12 1:22 
GeneralRe: Doxygen considered harmful PinmemberEddy Vluggen8-Oct-12 1:59 
GeneralRe: Doxygen considered harmful PinmemberYvesDaoust8-Oct-12 2:46 
GeneralRe: Doxygen considered harmful PinmemberMark Wallace8-Oct-12 2:32 
GeneralRe: Doxygen considered harmful PinmemberYvesDaoust8-Oct-12 2:51 
GeneralRe: Doxygen considered harmful PinmemberBrady Kelly8-Oct-12 3:12 
GeneralHTML Help considered harmful Pinmemberpeterchen8-Oct-12 2:38 
GeneralRe: HTML Help considered harmful PinmemberYvesDaoust8-Oct-12 2:55 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

Advertise | Privacy | Mobile
Web03 | 2.8.141223.1 | Last Updated 25 Dec 2014
Copyright © CodeProject, 1999-2014
All Rights Reserved. Terms of Service
Layout: fixed | fluid