100% documentation coverage.

Author: ioquatix

gems.rb

@@ -16,6 +16,8 @@
 	gem "bake-modernize"
 	gem "bake-releases"
 
+	gem "agent-context"
+	
 	gem "utopia-project"
 end
 

lib/ffi/clang.rb

@@ -32,10 +32,3 @@
 require_relative 'clang/types/record'
 require_relative 'clang/types/type_def'
 require_relative 'clang/types/vector'
-
-# @namespace
-module FFI
-	# @namespace
-	module Clang
-	end
-end

lib/ffi/clang/clang_version.rb

@@ -8,10 +8,14 @@
 
 module FFI
 	module Clang
+		# Get the version string of the libclang library.
+		# @returns [String] The libclang version string.
 		def self.clang_version_string
 			Lib.extract_string Lib.get_clang_version
 		end
 
+		# Get the libclang version as a Gem::Version object.
+		# @returns [Gem::Version] The parsed version.
 		def self.clang_version
 			clang_version = self.clang_version_string.match(/\d+\.\d+\.\d+/)
 			Gem::Version.new(clang_version)

lib/ffi/clang/code_completion.rb

@@ -9,83 +9,119 @@
 
 module FFI
 	module Clang
+		# @namespace
 		class CodeCompletion
+			# Get the default code completion options.
+			# @returns [Array(Symbol)] The default options.
 			def self.default_code_completion_options
 				Lib.opts_from(Lib::CodeCompleteFlags, Lib.default_code_completion_options)
 			end
 
+			# Represents code completion results.
 			class Results < FFI::AutoPointer
 				include Enumerable
 
+				# @attribute [Integer] The number of completion results.
 				attr_reader :size
+				
+				# @attribute [Array(Result)] The array of completion results.
 				attr_reader :results
 
+				# Initialize code completion results.
+				# @parameter code_complete_results [Lib::CXCodeCompleteResults] The completion results structure.
+				# @parameter translation_unit [TranslationUnit] The parent translation unit.
 				def initialize(code_complete_results, translation_unit)
 					super code_complete_results.pointer
 					@translation_unit = translation_unit
 					@code_complete_results = code_complete_results
 					initialize_results
 				end
 
+				# Release the completion results pointer.
+				# @parameter pointer [FFI::Pointer] The pointer to release.
 				def self.release(pointer)
           results = Lib::CXCodeCompleteResults.new(pointer)
 					Lib.dispose_code_complete_results(results)
 				end
 
+				# Iterate over each completion result.
+				# @yields {|result| ...} Each completion result.
+				# 	@parameter result [Result] The completion result.
 				def each(&block)
 					@results.each do |token|
 						block.call(token)
 					end
 				end
 
+				# Get the number of diagnostics.
+				# @returns [Integer] The number of diagnostics.
 				def num_diagnostics
 					Lib.get_code_complete_get_num_diagnostics(@code_complete_results)
 				end
 
+				# Get a diagnostic by index.
+				# @parameter i [Integer] The diagnostic index.
+				# @returns [Diagnostic] The diagnostic.
 				def diagnostic(i)
 					Diagnostic.new(@translation_unit, Lib.get_code_complete_get_diagnostic(@code_complete_results, i))
 				end
 
+				# Get all diagnostics.
+				# @returns [Array(Diagnostic)] Array of diagnostics.
 				def diagnostics
 					num_diagnostics.times.map { |i|
 						Diagnostic.new(@translation_unit, Lib.get_code_complete_get_diagnostic(@code_complete_results, i))
 					}
 				end
 
+				# Get the completion contexts.
+				# @returns [Array(Symbol)] The completion contexts.
 				def contexts
 					Lib.opts_from Lib::CompletionContext, Lib.get_code_complete_get_contexts(@code_complete_results)
 				end
 
+				# Get the USR of the container.
+				# @returns [String] The container USR.
 				def container_usr
 					Lib.extract_string Lib.get_code_complete_get_container_usr(@code_complete_results)
 				end
 
+				# Get the kind of the container.
+				# @returns [Symbol] The container kind.
 				def container_kind
 					is_incomplete = MemoryPointer.new :uint
 					Lib.get_code_complete_get_container_kind(@code_complete_results, is_incomplete)
 				end
 
+				# Check if the results are incomplete.
+				# @returns [Boolean] True if results are incomplete.
 				def incomplete?
 					is_incomplete = MemoryPointer.new :uint
 					Lib.get_code_complete_get_container_kind(@code_complete_results, is_incomplete)
 					is_incomplete.read_uint != 0
 				end
 
+				# Get the Objective-C selector.
+				# @returns [String] The Objective-C selector.
 				def objc_selector
 					Lib.extract_string Lib.get_code_complete_get_objc_selector(@code_complete_results)
 				end
 
+				# Sort the completion results in place.
 				def sort!
 					Lib.sort_code_completion_results(@code_complete_results[:results], @code_complete_results[:num])
 					initialize_results
 				end
 
+				# Get a string representation of the results.
+				# @returns [String] The results as a string.
 				def inspect
 					@results.inspect
 				end
 
 				private
 
+				# @private
 				def initialize_results
 					@size = @code_complete_results[:num]
 					cur_ptr = @code_complete_results[:results]
@@ -97,81 +133,123 @@ def initialize_results
 				end
 			end
 
+			# Represents a single code completion result.
 			class Result
+				# Initialize a completion result.
+				# @parameter result [Lib::CXCompletionResult] The completion result structure.
 				def initialize(result)
 					@result = result
 				end
 
+				# Get the kind of completion.
+				# @returns [Symbol] The completion kind.
 				def kind
 					@result[:kind]
 				end
 
+				# Get the completion string.
+				# @returns [CodeCompletion::String] The completion string.
 				def string
 					CodeCompletion::String.new @result[:string]
 				end
 
+				# Get a string representation of this result.
+				# @returns [String] The result as a string.
 				def inspect
 					"<#{kind.inspect} = #{string.inspect}>"
 				end
 			end
 
+			# Represents a code completion string with chunks.
 			class String
+				# Initialize a completion string.
+				# @parameter ptr [FFI::Pointer] The completion string pointer.
 				def initialize(ptr)
 					@pointer = ptr
 				end
 
+				# Get the kind of a chunk.
+				# @parameter i [Integer] The chunk index.
+				# @returns [Symbol] The chunk kind.
 				def chunk_kind(i)
 					Lib.get_completion_chunk_kind(@pointer, i)
 				end
 
+				# Get the text of a chunk.
+				# @parameter i [Integer] The chunk index.
+				# @returns [String] The chunk text.
 				def chunk_text(i)
 					Lib.extract_string Lib.get_completion_text(@pointer, i)
 				end
 
+				# Get the completion string of a chunk.
+				# @parameter i [Integer] The chunk index.
+				# @returns [CodeCompletion::String] The chunk's completion string.
 				def chunk_completion(i)
 					CodeCompletion::String.new Lib.get_completion_chunk_completion_string(@pointer, i)
 				end
 
+				# Get the number of chunks.
+				# @returns [Integer] The number of chunks.
 				def num_chunks
 					Lib.get_num_completion_chunks(@pointer)
 				end
 
+				# Get all chunks as an array of hashes.
+				# @returns [Array(Hash)] Array of chunk hashes with `:kind`, `:text`, and `:completion` keys.
 				def chunks
 					num_chunks.times.map { |i|
 						{ kind: chunk_kind(i), text: chunk_text(i), completion: chunk_completion(i) }
 					}
 				end
 
+				# Get the priority of this completion.
+				# @returns [Integer] The completion priority.
 				def priority
 					Lib.get_completion_priority(@pointer)
 				end
 
+				# Get the availability of this completion.
+				# @returns [Symbol] The completion availability.
 				def availability
 					Lib.get_completion_availability(@pointer)
 				end
 
+				# Get the number of annotations.
+				# @returns [Integer] The number of annotations.
 				def num_annotations
 					Lib.get_completion_num_annotations(@pointer)
 				end
 
+				# Get an annotation by index.
+				# @parameter i [Integer] The annotation index.
+				# @returns [String] The annotation text.
 				def annotation(i)
 					Lib.extract_string Lib.get_completion_annotation(@pointer, i)
 				end
 
+				# Get all annotations.
+				# @returns [Array(String)] Array of annotation strings.
 				def annotations
 					num_annotations.times.map { |i|
 						Lib.extract_string Lib.get_completion_annotation(@pointer, i)
 					}
 				end
 
+				# Get the parent context.
+				# @returns [String] The parent context.
 				def parent
 					Lib.extract_string Lib.get_completion_parent(@pointer, nil)
 				end
 
+				# Get the brief comment.
+				# @returns [String] The brief comment.
 				def comment
 					Lib.extract_string Lib.get_completion_brief_comment(@pointer)
 				end
 
+				# Get a string representation of this completion string.
+				# @returns [String] The chunks as a string.
 				def inspect
 					chunks.inspect
 				end