Permalink
Browse files

updated makefile and renamed docs folder to doc updated readme

  • Loading branch information...
1 parent d4b64de commit ef0f26bf09c51c935d5e2f0bb6f39a25de812199 @tbranyen tbranyen committed Apr 1, 2011
Showing with 270 additions and 2 deletions.
  1. +2 −2 Makefile
  2. +11 −0 README.md
  3. BIN doc/Data/ClassHierarchy.nd
  4. BIN doc/Data/ConfigFileInfo.nd
  5. +4 −0 doc/Data/FileInfo.nd
  6. BIN doc/Data/ImageFileInfo.nd
  7. BIN doc/Data/ImageReferenceTable.nd
  8. BIN doc/Data/IndexInfo.nd
  9. BIN doc/Data/PreviousMenuState.nd
  10. BIN doc/Data/PreviousSettings.nd
  11. BIN doc/Data/SymbolTable.nd
  12. +113 −0 doc/Languages.txt
  13. +59 −0 doc/Menu.txt
  14. +81 −0 doc/Topics.txt
  15. 0 {docs → doc}/api/commit.html
  16. 0 {docs → doc}/api/docco.css
  17. 0 {docs → doc}/api/error.html
  18. 0 {docs → doc}/api/index.html
  19. 0 {docs → doc}/api/oid.html
  20. 0 {docs → doc}/api/ref.html
  21. 0 {docs → doc}/api/repo.html
  22. 0 {docs → doc}/api/revwalk.html
  23. 0 {docs → doc}/api/sig.html
  24. 0 {docs → doc}/api/tree.html
  25. 0 {docs → doc}/api/util.html
  26. 0 {docs → doc}/files/blob-h.html
  27. 0 {docs → doc}/files/error-h.html
  28. 0 {docs → doc}/index.html
  29. 0 {docs → doc}/index/Classes.html
  30. 0 {docs → doc}/index/Functions.html
  31. 0 {docs → doc}/index/General.html
  32. 0 {docs → doc}/index/Variables.html
  33. 0 {docs → doc}/javascript/main.js
  34. 0 {docs → doc}/javascript/prettify.js
  35. 0 {docs → doc}/javascript/searchdata.js
  36. 0 {docs → doc}/search/ClassesG.html
  37. 0 {docs → doc}/search/ClassesL.html
  38. 0 {docs → doc}/search/FunctionsC.html
  39. 0 {docs → doc}/search/FunctionsE.html
  40. 0 {docs → doc}/search/FunctionsG.html
  41. 0 {docs → doc}/search/FunctionsI.html
  42. 0 {docs → doc}/search/FunctionsL.html
  43. 0 {docs → doc}/search/FunctionsN.html
  44. 0 {docs → doc}/search/FunctionsR.html
  45. 0 {docs → doc}/search/FunctionsS.html
  46. 0 {docs → doc}/search/GeneralB.html
  47. 0 {docs → doc}/search/GeneralC.html
  48. 0 {docs → doc}/search/GeneralE.html
  49. 0 {docs → doc}/search/GeneralF.html
  50. 0 {docs → doc}/search/GeneralG.html
  51. 0 {docs → doc}/search/GeneralI.html
  52. 0 {docs → doc}/search/GeneralL.html
  53. 0 {docs → doc}/search/GeneralN.html
  54. 0 {docs → doc}/search/GeneralR.html
  55. 0 {docs → doc}/search/GeneralS.html
  56. 0 {docs → doc}/search/GeneralV.html
  57. 0 {docs → doc}/search/NoResults.html
  58. 0 {docs → doc}/search/VariablesB.html
  59. 0 {docs → doc}/search/VariablesC.html
  60. 0 {docs → doc}/styles/main.css
View
@@ -43,6 +43,6 @@ lint:
@@$(NODE_JS) $(BASE)/util/hint-check.js
doc:
- @@$(NATURAL_DOCS_PATH)/NaturalDocs -i $(BASE)/include -o HTML $(BASE)/docs -p $(BASE)/docs -s $(BASE)/../Theme
+ @@$(NATURAL_DOCS_PATH)/NaturalDocs -i $(BASE)/include -o HTML $(BASE)/doc -p $(BASE)/doc -s $(BASE)/../Theme
-.PHONY: test build
+.PHONY: test build doc
View
@@ -184,6 +184,17 @@ If they are not, `cd` into the `nodegit` dir and run the following `git` command
Then simply run `make test` in the project root.
+Generating documentation
+------------------------
+
+__ `nodegit` native and library code is documented to be built with `Natural Docs`. __
+
+To create the documentation, `cd` into the `nodegit` dir and run the following:
+ $ cd nodegit
+ $ make doc
+
+The documentation will then generate in the `doc/` subfolder as HTML.
+
Release information
-------------------
View
Binary file not shown.
View
Binary file not shown.
View
@@ -0,0 +1,4 @@
+1.51
+C/C++
+/home/tim/git/nodegit/include/blob.h 1301620615 1 GitBlob
+/home/tim/git/nodegit/include/error.h 1301620603 1 GitError
View
Binary file not shown.
Binary file not shown.
View
Binary file not shown.
Binary file not shown.
Binary file not shown.
View
Binary file not shown.
View
@@ -0,0 +1,113 @@
+Format: 1.51
+
+# This is the Natural Docs languages file for this project. If you change
+# anything here, it will apply to THIS PROJECT ONLY. If you'd like to change
+# something for all your projects, edit the Languages.txt in Natural Docs'
+# Config directory instead.
+
+
+# You can prevent certain file extensions from being scanned like this:
+# Ignore Extensions: [extension] [extension] ...
+
+
+#-------------------------------------------------------------------------------
+# SYNTAX:
+#
+# Unlike other Natural Docs configuration files, in this file all comments
+# MUST be alone on a line. Some languages deal with the # character, so you
+# cannot put comments on the same line as content.
+#
+# Also, all lists are separated with spaces, not commas, again because some
+# languages may need to use them.
+#
+# Language: [name]
+# Alter Language: [name]
+# Defines a new language or alters an existing one. Its name can use any
+# characters. If any of the properties below have an add/replace form, you
+# must use that when using Alter Language.
+#
+# The language Shebang Script is special. It's entry is only used for
+# extensions, and files with those extensions have their shebang (#!) lines
+# read to determine the real language of the file. Extensionless files are
+# always treated this way.
+#
+# The language Text File is also special. It's treated as one big comment
+# so you can put Natural Docs content in them without special symbols. Also,
+# if you don't specify a package separator, ignored prefixes, or enum value
+# behavior, it will copy those settings from the language that is used most
+# in the source tree.
+#
+# Extensions: [extension] [extension] ...
+# [Add/Replace] Extensions: [extension] [extension] ...
+# Defines the file extensions of the language's source files. You can
+# redefine extensions found in the main languages file. You can use * to
+# mean any undefined extension.
+#
+# Shebang Strings: [string] [string] ...
+# [Add/Replace] Shebang Strings: [string] [string] ...
+# Defines a list of strings that can appear in the shebang (#!) line to
+# designate that it's part of the language. You can redefine strings found
+# in the main languages file.
+#
+# Ignore Prefixes in Index: [prefix] [prefix] ...
+# [Add/Replace] Ignored Prefixes in Index: [prefix] [prefix] ...
+#
+# Ignore [Topic Type] Prefixes in Index: [prefix] [prefix] ...
+# [Add/Replace] Ignored [Topic Type] Prefixes in Index: [prefix] [prefix] ...
+# Specifies prefixes that should be ignored when sorting symbols in an
+# index. Can be specified in general or for a specific topic type.
+#
+#------------------------------------------------------------------------------
+# For basic language support only:
+#
+# Line Comments: [symbol] [symbol] ...
+# Defines a space-separated list of symbols that are used for line comments,
+# if any.
+#
+# Block Comments: [opening sym] [closing sym] [opening sym] [closing sym] ...
+# Defines a space-separated list of symbol pairs that are used for block
+# comments, if any.
+#
+# Package Separator: [symbol]
+# Defines the default package separator symbol. The default is a dot.
+#
+# [Topic Type] Prototype Enders: [symbol] [symbol] ...
+# When defined, Natural Docs will attempt to get a prototype from the code
+# immediately following the topic type. It stops when it reaches one of
+# these symbols. Use \n for line breaks.
+#
+# Line Extender: [symbol]
+# Defines the symbol that allows a prototype to span multiple lines if
+# normally a line break would end it.
+#
+# Enum Values: [global|under type|under parent]
+# Defines how enum values are referenced. The default is global.
+# global - Values are always global, referenced as 'value'.
+# under type - Values are under the enum type, referenced as
+# 'package.enum.value'.
+# under parent - Values are under the enum's parent, referenced as
+# 'package.value'.
+#
+# Perl Package: [perl package]
+# Specifies the Perl package used to fine-tune the language behavior in ways
+# too complex to do in this file.
+#
+#------------------------------------------------------------------------------
+# For full language support only:
+#
+# Full Language Support: [perl package]
+# Specifies the Perl package that has the parsing routines necessary for full
+# language support.
+#
+#-------------------------------------------------------------------------------
+
+# The following languages are defined in the main file, if you'd like to alter
+# them:
+#
+# Text File, Shebang Script, C/C++, C#, Java, JavaScript, Perl, Python,
+# PHP, SQL, Visual Basic, Pascal, Assembly, Ada, Tcl, Ruby, Makefile,
+# ActionScript, ColdFusion, R, Fortran
+
+# If you add a language that you think would be useful to other developers
+# and should be included in Natural Docs by default, please e-mail it to
+# languages [at] naturaldocs [dot] org.
View
@@ -0,0 +1,59 @@
+Format: 1.51
+
+
+# You can add a title and sub-title to your menu like this:
+# Title: [project name]
+# SubTitle: [subtitle]
+
+# You can add a footer to your documentation like this:
+# Footer: [text]
+# If you want to add a copyright notice, this would be the place to do it.
+
+# You can add a timestamp to your documentation like one of these:
+# Timestamp: Generated on month day, year
+# Timestamp: Updated mm/dd/yyyy
+# Timestamp: Last updated mon day
+#
+# m - One or two digit month. January is "1"
+# mm - Always two digit month. January is "01"
+# mon - Short month word. January is "Jan"
+# month - Long month word. January is "January"
+# d - One or two digit day. 1 is "1"
+# dd - Always two digit day. 1 is "01"
+# day - Day with letter extension. 1 is "1st"
+# yy - Two digit year. 2006 is "06"
+# yyyy - Four digit year. 2006 is "2006"
+# year - Four digit year. 2006 is "2006"
+
+
+# --------------------------------------------------------------------------
+#
+# Cut and paste the lines below to change the order in which your files
+# appear on the menu. Don't worry about adding or removing files, Natural
+# Docs will take care of that.
+#
+# You can further organize the menu by grouping the entries. Add a
+# "Group: [name] {" line to start a group, and add a "}" to end it.
+#
+# You can add text and web links to the menu by adding "Text: [text]" and
+# "Link: [name] ([URL])" lines, respectively.
+#
+# The formatting and comments are auto-generated, so don't worry about
+# neatness when editing the file. Natural Docs will clean it up the next
+# time it is run. When working with groups, just deal with the braces and
+# forget about the indentation and comments.
+#
+# --------------------------------------------------------------------------
+
+
+File: GitBlob (blob.h)
+File: GitError (error.h)
+
+Group: Index {
+
+ Index: Everything
+ Class Index: Classes
+ Function Index: Functions
+ Variable Index: Variables
+ } # Group: Index
+
View
@@ -0,0 +1,81 @@
+Format: 1.51
+
+# This is the Natural Docs topics file for this project. If you change anything
+# here, it will apply to THIS PROJECT ONLY. If you'd like to change something
+# for all your projects, edit the Topics.txt in Natural Docs' Config directory
+# instead.
+
+
+# If you'd like to prevent keywords from being recognized by Natural Docs, you
+# can do it like this:
+# Ignore Keywords: [keyword], [keyword], ...
+#
+# Or you can use the list syntax like how they are defined:
+# Ignore Keywords:
+# [keyword]
+# [keyword], [plural keyword]
+# ...
+
+
+#-------------------------------------------------------------------------------
+# SYNTAX:
+#
+# Topic Type: [name]
+# Alter Topic Type: [name]
+# Creates a new topic type or alters one from the main file. Each type gets
+# its own index and behavior settings. Its name can have letters, numbers,
+# spaces, and these charaters: - / . '
+#
+# Plural: [name]
+# Sets the plural name of the topic type, if different.
+#
+# Keywords:
+# [keyword]
+# [keyword], [plural keyword]
+# ...
+# Defines or adds to the list of keywords for the topic type. They may only
+# contain letters, numbers, and spaces and are not case sensitive. Plural
+# keywords are used for list topics. You can redefine keywords found in the
+# main topics file.
+#
+# Index: [yes|no]
+# Whether the topics get their own index. Defaults to yes. Everything is
+# included in the general index regardless of this setting.
+#
+# Scope: [normal|start|end|always global]
+# How the topics affects scope. Defaults to normal.
+# normal - Topics stay within the current scope.
+# start - Topics start a new scope for all the topics beneath it,
+# like class topics.
+# end - Topics reset the scope back to global for all the topics
+# beneath it.
+# always global - Topics are defined as global, but do not change the scope
+# for any other topics.
+#
+# Class Hierarchy: [yes|no]
+# Whether the topics are part of the class hierarchy. Defaults to no.
+#
+# Page Title If First: [yes|no]
+# Whether the topic's title becomes the page title if it's the first one in
+# a file. Defaults to no.
+#
+# Break Lists: [yes|no]
+# Whether list topics should be broken into individual topics in the output.
+# Defaults to no.
+#
+# Can Group With: [type], [type], ...
+# Defines a list of topic types that this one can possibly be grouped with.
+# Defaults to none.
+#-------------------------------------------------------------------------------
+
+# The following topics are defined in the main file, if you'd like to alter
+# their behavior or add keywords:
+#
+# Generic, Class, Interface, Section, File, Group, Function, Variable,
+# Property, Type, Constant, Enumeration, Event, Delegate, Macro,
+# Database, Database Table, Database View, Database Index, Database
+# Cursor, Database Trigger, Cookie, Build Target
+
+# If you add something that you think would be useful to other developers
+# and should be included in Natural Docs by default, please e-mail it to
+# topics [at] naturaldocs [dot] org.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit ef0f26b

Please sign in to comment.