Matt Williams avatar Matt Williams committed c81a799

Add some documentation for the new funtion.

Comments (0)

Files changed (1)

doxylink/sphinxcontrib/doxylink.py

 	return None
 
 def parse_tag_file(doc):
+	"""
+	Takes in an XML free from a Doxygen tag file and returns a dictionary that looks something like:
+	
+	.. code-block:: python
+	
+		{'PolyVox': {'file': 'namespace_poly_vox.html', 'kind': 'namespace'},
+		 'PolyVox::Array': {'file': 'class_poly_vox_1_1_array.html', 'kind': 'class'},
+		 'PolyVox::Array1DDouble': {'file': 'namespace_poly_vox.html#a7a1f5fd5c4f7fbb4258a495d707b5c13',
+		                            'kind': 'typedef'},
+		 'PolyVox::Array1DFloat': {'file': 'namespace_poly_vox.html#a879a120e49733eba1905c33f8a7f131b',
+		                           'kind': 'typedef'},
+		 'PolyVox::Array1DInt16': {'file': 'namespace_poly_vox.html#aa1463ece448c6ebed55ab429d6ae3e43',
+		                           'kind': 'typedef'}}
+	
+	:Parameters:
+		doc : xml.etree.ElementTree
+			The XML DOM object
+	
+	:return: a dictionary mapping fully qualified symbols to files
+	"""
 	mapping = {}
 	for compound in doc.findall(".//compound"):
 		if compound.get('kind') != 'namespace' and compound.get('kind') != 'class':
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.