> -----Original Message----- > From: sergio On Behalf Of Sergio Martins > Sent: Thursday, March 17, 2016 3:16 PM > To: Koehne Kai <[email protected]> > Cc: [email protected] > Subject: Re: [Development] Qt Coding Guidelines > > On Thursday, March 17, 2016 02:30:03 PM Koehne Kai wrote: > > (snip) > > > Completely orthogonal to this is though in which format the documents > > are. You're specifically mentioning .qdoc, but I assume it wouldn't > > really matter if it's Markdown (from the 'reusability' perspective)? > > If we keep these documents private then I would say .qdoc vs .md is a > bikeshed and whoever is doing the hard work of writing and maintaining it > should decide. > > But for public distribution I don't think it's fine. > > If I recommend the Qt coding style to a customer, he'll come back and say > "How do I open this?".
How do they open a .qdoc file? They probably don't, but browse the generated .html documentation. The same can be done with markdown. > Afaik, you can't just point your browser to it and > open it while offline, you have to go to a gitweb site and view it there, > otherwise no pretty formatting. Well ... it's becoming increasingly popular, and there's countless ways nowadays to render markdown. It's so easy in fact that we ship one with Qt :) https://doc.qt.io/qt-5/qtwebengine-webenginewidgets-markdowneditor-example.html That being said, I'm not fixed on using the .md format. I was just surprised you considered .qdoc more 'reusable' than Markdown. Regards Kai _______________________________________________ Development mailing list [email protected] http://lists.qt-project.org/mailman/listinfo/development
