doxyparser 1.5 → 1.5.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: ddb97c91354a56d85495ca4dd7fdda3be9d02806
4
- data.tar.gz: 78a25a5f867401e60d7212433cdb8a9d36debf74
3
+ metadata.gz: 066e701f906327ea372804849dde302e29e82dfa
4
+ data.tar.gz: 253ac2e8452a87068da4158d94316c5d958e65b3
5
5
  SHA512:
6
- metadata.gz: db5492d5aef0f23620ea7cd3af58726feae425fa83389195eb25f6dca1ff498bef49e1f591b4ad26ee4d5148d7f42b5920f7f4df629a702a368a8da646c50600
7
- data.tar.gz: 8f26ecc142d43c7f71d3de4df6970d3b260aff6ffe626d7761749946996f2bc78da3a184d479458fc4b12f3f700446cc09228e0380b61f77fdc7024bda14b107
6
+ metadata.gz: 96f016b0ad4c02fe5cc7712cc65d1d1dc09296bbc96ca34c4c7918978af1cbeef3c1a906734531dabd68763bd95649303d994de6d95d96392bc03082755e4402
7
+ data.tar.gz: 9a0c2c3470db0d7616099ad596e5e60f353fd08b7815220b48916d17dcdb78f7c6f994eaf1c251cefe822eb1d6876bb033fcbf8f0efb26511dddc4e94129cd21
data/README.md CHANGED
@@ -24,6 +24,12 @@ and run `bundle install` from your shell.
24
24
 
25
25
  In order to use Doxyparser you need to first install Doxygen (www.doxygen.org) in your computer and Nokogiri (http://nokogiri.org)
26
26
 
27
+ It is highly encouraged to consult the YARD documentation in the ./doc subdirectory. In addition to this you can:
28
+
29
+
30
+ Learn by example:
31
+ -------------------
32
+
27
33
  Generating intermediate XML representation
28
34
  ------------------------------------------
29
35
 
@@ -77,6 +83,7 @@ Querying Members
77
83
  Namespaces
78
84
  -----------
79
85
 
86
+ ```ruby
80
87
  namespace_classes = namespace.classes # List of Doxyparser::Class
81
88
  namespace_structs = namespace.structs # List of Doxyparser::Struct
82
89
  inner_namespaces = namespace.innernamespaces # List of Doxyparser::Namespace
@@ -84,6 +91,7 @@ namepace_enums = namespace.enums # List of Doxyparser::Enum
84
91
  namespace_variables = namespace.variables # List of Doxyparser::Variable
85
92
  namespace_functions = namespace.functions # List of Doxyparser::Function
86
93
  namespace_typedefs = namespace.typedefs # List of Doxyparser::Typedef
94
+ ```
87
95
 
88
96
  ...and:
89
97
 
@@ -168,12 +168,12 @@ module Doxyparser
168
168
  _typedefs(access, filter)
169
169
  end
170
170
 
171
- private
172
171
 
173
172
  attr_reader :file
174
173
  attr_reader :friends
175
174
  attr_reader :template_params
176
175
 
176
+ private
177
177
 
178
178
  def _methods(access = :public, static = nil, filter = nil)
179
179
  if static.nil?
@@ -8,7 +8,7 @@ module Doxyparser
8
8
  attr_reader :escaped_name
9
9
 
10
10
  # If this {Type} has type parameters (aka. template params) finds nested {Type}s
11
- # for other {Classes} or {Structs} parsed by Doxyparser.
11
+ # for other {Class}es or {Struct}s parsed by Doxyparser.
12
12
  # The 'main' type is always included, so for templates two or more types will be returned.
13
13
  # Example: for MyNamespace::map<std::string, MyClass> the result is: [MyNamespace::map, MyNamespace::MyClass]
14
14
  # @return [Array<Type>] Nested types
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: doxyparser
3
3
  version: !ruby/object:Gem::Version
4
- version: '1.5'
4
+ version: 1.5.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - David Fuenmayor
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2014-04-18 00:00:00.000000000 Z
11
+ date: 2014-04-24 00:00:00.000000000 Z
12
12
  dependencies: []
13
13
  description: |
14
14
  Ruby Gem for parsing C++ header files.