Kludge Tracker: Gnuradio - v3.4.0-101-g7e2b45b

Kludge Summary of gnuradio/docs

All Directories within gnuradio/docs

• gnuradio/docs/doxygen (11)
• gnuradio/docs/doxygen/other (10)
• gnuradio/docs/howto-write-a-block (3)

All Files within gnuradio/docs

• gnuradio/docs/doxygen/Doxyfile.in (1)
• gnuradio/docs/doxygen/other/doxypy.py (10)
• gnuradio/docs/howto-write-a-block/howto_1.i (1)
• gnuradio/docs/howto-write-a-block/src_lib_Makefile_1.am (1)
• gnuradio/docs/howto-write-a-block/src_lib_Makefile_2.am (1)

Kludge Snippets in gnuradio/docs

gnuradio/docs/doxygen/Doxyfile.in

410        
411        SORT_BY_SCOPE_NAME     = NO
412        
413        # The GENERATE_TODOLIST tag can be used to enable (YES) or 
414        # disable (NO) the todo list. This list is created by putting \todo 
415        # commands in the documentation.
416        
417        GENERATE_TODOLIST      = NO
418        
				

gnuradio/docs/doxygen/other/doxypy.py — 1

84        				if match:
85        					self.current_state = to_state
86        					self.current_input = input
87        					self.current_transition = transition
88        					if options.debug:
89        						print >>sys.stderr, "# FSM: executing (%s -> %s) for line '%s'" % (from_state, to_state, input)
90        					callback(match)
91        					return
92        
				

gnuradio/docs/doxygen/other/doxypy.py — 2

178        
179        	def __closeComment(self):
180        		"""Appends any open comment block and triggering block to the output."""
181        		
182        		if options.autobrief:
183        			if len(self.comment) == 1 \
184        			or (len(self.comment) > 2 and self.comment[1].strip() == ''):
185        				self.comment[0] = self.__docstringSummaryToBrief(self.comment[0])
186        			
				

gnuradio/docs/doxygen/other/doxypy.py — 3

206        	def __flushBuffer(self):
207        		"""Flushes the current outputbuffer to the outstream."""
208        		if self.output:
209        			try:
210        				if options.debug:
211        					print >>sys.stderr, "# OUTPUT: ", self.output
212        				print >>self.outstream, "\n".join(self.output)
213        				self.outstream.flush()
214        			except IOError:
				

gnuradio/docs/doxygen/other/doxypy.py — 4

226        		"""Restarts a new comment search for a different triggering line.
227        		
228        		Closes the current commentblock and starts a new comment search.
229        		"""
230        		if options.debug:
231        			print >>sys.stderr, "# CALLBACK: resetCommentSearch" 
232        		self.__closeComment()
233        		self.startCommentSearch(match)
234        	
				

gnuradio/docs/doxygen/other/doxypy.py — 5

237        		
238        		Saves the triggering line, resets the current comment and saves
239        		the current indentation.
240        		"""
241        		if options.debug:
242        			print >>sys.stderr, "# CALLBACK: startCommentSearch"
243        		self.defclass = [self.fsm.current_input]
244        		self.comment = []
245        		self.indent = match.group(1)
				

gnuradio/docs/doxygen/other/doxypy.py — 6

249        		
250        		Closes the current commentblock, resets	the triggering line and
251        		appends the current line to the output.
252        		"""
253        		if options.debug:
254        			print >>sys.stderr, "# CALLBACK: stopCommentSearch" 
255        		self.__closeComment()
256        		
257        		self.defclass = []
				

gnuradio/docs/doxygen/other/doxypy.py — 7

261        		"""Appends a line in the FILEHEAD state.
262        		
263        		Closes the open comment	block, resets it and appends the current line.
264        		""" 
265        		if options.debug:
266        			print >>sys.stderr, "# CALLBACK: appendFileheadLine" 
267        		self.__closeComment()
268        		self.comment = []
269        		self.output.append(self.fsm.current_input)
				

gnuradio/docs/doxygen/other/doxypy.py — 8

273        		
274        		The comment delimiter is removed from multiline start and ends as
275        		well as singleline comments.
276        		"""
277        		if options.debug:
278        			print >>sys.stderr, "# CALLBACK: appendCommentLine" 
279        		(from_state, to_state, condition, callback) = self.fsm.current_transition
280        		
281        		# single line comment
				

gnuradio/docs/doxygen/other/doxypy.py — 9

310        			self.comment.append(self.fsm.current_input)
311        	
312        	def appendNormalLine(self, match):
313        		"""Appends a line to the output."""
314        		if options.debug:
315        			print >>sys.stderr, "# CALLBACK: appendNormalLine" 
316        		self.output.append(self.fsm.current_input)
317        		
318        	def appendDefclassLine(self, match):
				

gnuradio/docs/doxygen/other/doxypy.py — 10

316        		self.output.append(self.fsm.current_input)
317        		
318        	def appendDefclassLine(self, match):
319        		"""Appends a line to the triggering block."""
320        		if options.debug:
321        			print >>sys.stderr, "# CALLBACK: appendDefclassLine" 
322        		self.defclass.append(self.fsm.current_input)
323        	
324        	def makeCommentBlock(self):
				

gnuradio/docs/howto-write-a-block/howto_1.i

14        /*
15         * First arg is the package prefix.
16         * Second arg is the name of the class minus the prefix.
17         *
18         * This does some behind-the-scenes magic so we can
19         * access howto_square_ff from python as howto.square_ff
20         */
21        GR_SWIG_BLOCK_MAGIC(howto,square_ff);
22        
				

gnuradio/docs/howto-write-a-block/src_lib_Makefile_1.am

14        # These are the source files that go into the shared library
15        _howto_la_SOURCES = 			\
16        	howto_square_ff.cc		
17        
18        # magic flags
19        _howto_la_LDFLAGS = -module -avoid-version
20        
21        # These headers get installed in ${prefix}/include/gnuradio
22        grinclude_HEADERS =			\
				

gnuradio/docs/howto-write-a-block/src_lib_Makefile_2.am

62        _howto_la_SOURCES = 			\
63        	howto.cc			\
64        	howto_square_ff.cc		
65        
66        # magic flags
67        _howto_la_LDFLAGS = -module -avoid-version
68        
69        # link the library against some comon swig runtime code and the 
70        # c++ standard library