Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

switch to Doxygen

  • Loading branch information...
commit 5c722544f5df4adef39a2ee436b2b23f0224714f 1 parent df4fdfe
@jeremie-koenig authored
Showing with 18 additions and 16 deletions.
  1. +10 −10 Doxyfile
  2. +3 −1 Makefile
  3. +5 −5 mach/MachMsg.java
View
20 Doxyfile
@@ -25,7 +25,7 @@ DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
-PROJECT_NAME =
+PROJECT_NAME = hurd-java
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
@@ -37,7 +37,7 @@ PROJECT_NUMBER =
# for a project that appears at the top of each page and should give viewer
# a quick idea about the purpose of the project. Keep the description short.
-PROJECT_BRIEF =
+PROJECT_BRIEF = "Java bindings for Mach and Hurd"
# With the PROJECT_LOGO tag one can specify an logo or icon that is
# included in the documentation. The maximum height of the logo should not
@@ -51,7 +51,7 @@ PROJECT_LOGO =
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
-OUTPUT_DIRECTORY =
+OUTPUT_DIRECTORY = doc.n
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output
@@ -150,7 +150,7 @@ SHORT_NAMES = NO
# comments will behave just like regular Qt-style comments
# (thus requiring an explicit @brief command for a brief description.)
-JAVADOC_AUTOBRIEF = NO
+JAVADOC_AUTOBRIEF = YES
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
# interpret the first line (until the first dot) of a Qt-style
@@ -206,7 +206,7 @@ OPTIMIZE_OUTPUT_FOR_C = NO
# Java. For instance, namespaces will be presented as packages, qualified
# scopes will look different, etc.
-OPTIMIZE_OUTPUT_JAVA = NO
+OPTIMIZE_OUTPUT_JAVA = YES
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources only. Doxygen will then generate output that is more tailored for
@@ -318,7 +318,7 @@ SYMBOL_CACHE_SIZE = 0
# Private class members and static file members will be hidden unless
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
-EXTRACT_ALL = NO
+EXTRACT_ALL = YES
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
# will be included in the documentation.
@@ -610,7 +610,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT =
+INPUT = mach hurd
# 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
@@ -699,7 +699,7 @@ IMAGE_PATH =
# If FILTER_PATTERNS is specified, this tag will be
# ignored.
-INPUT_FILTER =
+INPUT_FILTER = "sed -e 's_{@code \([^}]*\)}_<tt>\1</tt>_g'"
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis.
@@ -735,7 +735,7 @@ FILTER_SOURCE_PATTERNS =
# Note: To get rid of all source code in the generated output, make sure also
# VERBATIM_HEADERS is set to NO.
-SOURCE_BROWSER = NO
+SOURCE_BROWSER = YES
# Setting the INLINE_SOURCES tag to YES will include the body
# of functions and classes directly in the documentation.
@@ -1160,7 +1160,7 @@ SERVER_BASED_SEARCH = NO
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
# generate Latex output.
-GENERATE_LATEX = YES
+GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
View
4 Makefile
@@ -23,7 +23,9 @@ $(CLASSES): $(JAVASRCS)
$(JAVAC) $(JAVASRCS)
doc: $(JAVASRCS)
- $(JAVADOC) $(JAVADOCFLAGS) -d $@.n $(JAVASRCS)
+ #$(JAVADOC) $(JAVADOCFLAGS) -d $@.n $(JAVASRCS)
+ # Use doxygen for now
+ doxygen
$(RM) -r $@
mv $@.n $@
View
10 mach/MachMsg.java
@@ -55,9 +55,9 @@ public TypeCheckException(String msg) {
*
* This enumeration is used to write and check the type descriptors in a
* Mach message. Each member represents a possible data type. The
- * {@link #put} and {@link #get} methods read and write {@code
- * mach_msg_type_t} (or {@code mach_msg_long_type_t}) structures from/to
- * a given ByteBuffer object.
+ * {@link #put} and {@link #get} methods read and write
+ * {@code mach_msg_type_t} (or {@code mach_msg_long_type_t}) structures
+ * from/to a given ByteBuffer object.
*
* In case an exception occurs, the buffer position can be anywhere
* between its original value and the end of the type descriptor being
@@ -217,8 +217,8 @@ public int get(ByteBuffer buf) throws TypeCheckException {
* Check the type descriptor read from the given ByteBuffer.
*
* This version behaves the same was as {@link #get(ByteBuffer)}
- * does, but additionally checks the type descriptor's {@code
- * msgt_number} field instead of returning it.
+ * does, but additionally checks the type descriptor's
+ * {@code msgt_number} field instead of returning it.
*/
public void get(ByteBuffer buf, int expectedNumber)
throws TypeCheckException
Please sign in to comment.
Something went wrong with that request. Please try again.