Skip to content

Commit

Permalink
Add the existing docs to the doxygen output
Browse files Browse the repository at this point in the history
  • Loading branch information
AlanGriffiths committed Aug 1, 2016
1 parent b9e5392 commit 8bd8224
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 9 deletions.
2 changes: 1 addition & 1 deletion building_and_using_miral.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Building and using Miral
Building and using MirAL {#building_and_using_miral}
========================

These instructions assume that you’re using Ubuntu 16.04LTS or later, I’ve not
Expand Down
4 changes: 3 additions & 1 deletion doc/Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -665,7 +665,9 @@ WARN_LOGFILE =
# with spaces.

INPUT = @CMAKE_CURRENT_SOURCE_DIR@/doc \
@CMAKE_CURRENT_SOURCE_DIR@/include
@CMAKE_CURRENT_SOURCE_DIR@/include \
@CMAKE_CURRENT_SOURCE_DIR@/building_and_using_miral.md \
@CMAKE_CURRENT_SOURCE_DIR@/tasks_for_the_interested_reader.md

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
Expand Down
2 changes: 1 addition & 1 deletion doc/footer.html.in
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<hr>
<p align="center">Copyright &copy; 201666666 Canonical Ltd. <br />
<p align="center">Copyright &copy; 2016 Canonical Ltd. <br />
Generated on @DATE_TODAY@</p>
</body>
</html>
6 changes: 6 additions & 0 deletions doc/mainpage.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,9 @@ ranging from Linux desktop to mobile devices powered by Ubuntu. The primary
purpose of Mir is to enable the development of the next generation
[Unity](http://unity.ubuntu.com).


Notes for Developers
--------------------

- \ref building_and_using_miral
- \ref tasks_for_the_interested_reader
12 changes: 6 additions & 6 deletions tasks_for_the_interested_reader.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Tasks for the interested reader
Tasks for the interested reader {#tasks_for_the_interested_reader}
===============================

MirAL needs to grow based on feeback on what shell developers really need. The
Expand Down Expand Up @@ -97,11 +97,11 @@ for a better approach:
smaller tiles having equal height, to host the remaining windows, with
older windows being closer to the bottom.

- Add a titlebar to the top of the screen. The titlebar should be split evenly
into horizontal blocks, one per tile. Each block containing the title of the
top-level window. The focussed tile is highlighted. Clicking on a title
selects the corresponding window.
- Add a titlebar to the top of the screen. The titlebar should be split evenly
into horizontal blocks, one per tile. Each block containing the title of the
top-level window. The focussed tile is highlighted. Clicking on a title
selects the corresponding window.

Art Resource
------------

Expand Down

0 comments on commit 8bd8224

Please sign in to comment.