Apologies for only sending to Jean-Marc initially. I end up doing this mistake a lot with gmail these days. /C
---------- Forwarded message ---------- From: Christian Ridderström <c...@lyx.org> Date: 8 April 2017 at 16:06 Subject: Re: Doxygen sourcedoc: Should there be a non-empty "main" page? To: Jean-Marc Lasgouttes <lasgout...@lyx.org> On 7 April 2017 at 10:16, Jean-Marc Lasgouttes <lasgout...@lyx.org> wrote: > Doxygen can take the content of e.g. a README or some other document and >> use that as the main page. >> The main page can be an introduction to developers, or simply a bunch of >> links to other developer documents. >> If anyone want's examples, here are some "main pages": >> > > What can we have there? The contents of our coding rules? Some content > that we would steal from the wiki? I have no idea. Perhaps the first question is who is the reader of 'sourcedoc'... or indeed if there's even anyone who actually read them? Right now the 'sourcedoc' isn't very discoverable.. IMHO, the type of reader should decide what, if any, information that might be useful to show on such a page. We could have e.g.: - Links to relevant wiki pages - E.g. coding rules - Link to Developer.lyx - If they exist, links to other documents (or posts on lyx-devel I suppose), explaining overall design of LyX (Such info is perhaps better kept in a wiki or a LyX document). Notes: - I see no point in duplicating information between the wiki and a main page, linking to wiki should be fine. - If it's important to keep the info (on a main page) under the same version control as the source code, then it might make sense to write it there. So perhaps coding rules is something that's suited for 'sourcedoc'. * The Xerces-C++ Documentation >> <http://xerces.apache.org/xerces-c/apiDocs-3/classes.html> >> > > Note that the main page for this one is actually empty. I think it's ok to leave a 'main page' empty. Or perhaps with just the text "intentionally empty" as I started this thread because I noticed it was empty and wasn't sure if I'd missed something when generating the pages. Then I thought I should explain that this option exist, in case we'd like to use it. /C
